The name of the metric namespace in the filter.
" + "smithy.api#documentation": "The name of the metric namespace for this filter.
\nThe namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must\n\t\t\tcontain at least one non-whitespace character.
" + } + }, + "MetricNames": { + "target": "com.amazonaws.cloudwatch#MetricStreamFilterMetricNames", + "traits": { + "smithy.api#documentation": "The names of the metrics to either include or exclude from the metric stream.
\nIf you omit this parameter, all metrics in the namespace are included or excluded, \n\t\tdepending on whether this filter is specified as an exclude filter or an include filter.
\nEach metric name can contain only ASCII printable characters (ASCII range 32 through 126). \n\t\t\tEach metric name must contain at least one non-whitespace character.
" } } }, "traits": { - "smithy.api#documentation": "This structure contains the name of one of the metric namespaces that is listed in\n\t\ta filter of a metric stream.
\nThe namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must\n\t\t\tcontain at least one non-whitespace character.
" + "smithy.api#documentation": "This structure contains a metric namespace and optionally, a list of metric names, \n\t\t\tto either include in a metric stream or exclude from\n\t\t\ta metric stream.
\nA metric stream's filters can include up to 1000 total names. This limit\n\t\t\tapplies to the sum of namespace names and metric names in the filters. For example, \n\t\tthis could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters\n\t\twith 49 metrics specified in each filter.
" + } + }, + "com.amazonaws.cloudwatch#MetricStreamFilterMetricNames": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudwatch#MetricName" } }, "com.amazonaws.cloudwatch#MetricStreamFilters": { @@ -5749,7 +5761,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates an alarm and associates it with the specified metric, metric math expression, \n\t\t\tanomaly detection model, or Metrics Insights query. For more information about using \n\t\t\ta Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.
\nAlarms based on anomaly detection models cannot have Auto Scaling actions.
\nWhen this operation creates an alarm, the alarm state is immediately set to\n\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the\n\t\t\tupdate completely overwrites the previous configuration of the alarm.
\nIf you are an IAM user, you must have \n\t\t\tAmazon EC2 permissions for some alarm operations:
\nThe iam:CreateServiceLinkedRole permission for all alarms with EC2 actions
The iam:CreateServiceLinkedRole permissions to create an alarm\n\t\t\t\t\twith Systems Manager OpsItem or response plan actions.
The first time you create an alarm in the \n\t\t\tAmazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch\n\t\t\tcreates the necessary service-linked role for you. The service-linked roles \n\t\t\tare called AWSServiceRoleForCloudWatchEvents and \n\t\t\tAWSServiceRoleForCloudWatchAlarms_ActionSSM.\n\t\t\tFor more information, see Amazon Web Services service-linked role.
\n Cross-account alarms\n
\nYou can set an alarm on metrics in the current account, or in another \n\t\t\taccount. To create a cross-account alarm that watches a metric in a different account, you must have completed the following\n\t\t\tpre-requisites:
\nThe account where the metrics are located (the sharing account) must \n\t\t\t\talready have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already \n\t\t\t\thave this role, you must create it using the instructions in Set up a\n\t\t\t\t\tsharing account in \n\t\t\t\t\tCross-account cross-Region CloudWatch console. The policy for that\n\t\t\t\trole must grant access\n\t\t\t\tto the ID of the account where you are creating the alarm.\n\t\t\t
\nThe account where you are creating the alarm (the monitoring account) must \n\t\t\t\talready have a service-linked role named\n\t\t\t\tAWSServiceRoleForCloudWatchCrossAccount to allow \n\t\t\t\tCloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a\n\t\t\t\t\tmonitoring account in \n\t\t\t\t\t\tCross-account cross-Region CloudWatch console.
\nCreates or updates an alarm and associates it with the specified metric, metric math expression, \n\t\t\tanomaly detection model, or Metrics Insights query. For more information about using \n\t\t\ta Metrics Insights query for an alarm, see Create alarms on Metrics Insights queries.
\nAlarms based on anomaly detection models cannot have Auto Scaling actions.
\nWhen this operation creates an alarm, the alarm state is immediately set to\n\t\t\tINSUFFICIENT_DATA. The alarm is then evaluated and its state is set\n\t\t\tappropriately. Any actions associated with the new state are then executed.
When you update an existing alarm, its state is left unchanged, but the\n\t\t\tupdate completely overwrites the previous configuration of the alarm.
\nIf you are an IAM user, you must have \n\t\t\tAmazon EC2 permissions for some alarm operations:
\nThe iam:CreateServiceLinkedRole permission for all alarms with EC2 actions
The iam:CreateServiceLinkedRole permissions to create an alarm\n\t\t\t\t\twith Systems Manager OpsItem or response plan actions.
The first time you create an alarm in the \n\t\t\tAmazon Web Services Management Console, the CLI, or by using the PutMetricAlarm API, CloudWatch\n\t\t\tcreates the necessary service-linked role for you. The service-linked roles \n\t\t\tare called AWSServiceRoleForCloudWatchEvents and \n\t\t\tAWSServiceRoleForCloudWatchAlarms_ActionSSM.\n\t\t\tFor more information, see Amazon Web Services service-linked role.
Each PutMetricAlarm action has a maximum uncompressed payload of 120 KB.
\n Cross-account alarms\n
\nYou can set an alarm on metrics in the current account, or in another \n\t\t\taccount. To create a cross-account alarm that watches a metric in a different account, you must have completed the following\n\t\t\tpre-requisites:
\nThe account where the metrics are located (the sharing account) must \n\t\t\t\talready have a sharing role named CloudWatch-CrossAccountSharingRole. If it does not already \n\t\t\t\thave this role, you must create it using the instructions in Set up a\n\t\t\t\t\tsharing account in \n\t\t\t\t\tCross-account cross-Region CloudWatch console. The policy for that\n\t\t\t\trole must grant access\n\t\t\t\tto the ID of the account where you are creating the alarm.\n\t\t\t
\nThe account where you are creating the alarm (the monitoring account) must \n\t\t\t\talready have a service-linked role named\n\t\t\t\tAWSServiceRoleForCloudWatchCrossAccount to allow \n\t\t\t\tCloudWatch to assume the sharing role in the sharing account. If it does not, you must create it following the directions in Set up a\n\t\t\t\t\tmonitoring account in \n\t\t\t\t\t\tCross-account cross-Region CloudWatch console.
\nThe actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:
\n EC2 actions:\n
\n\n arn:aws:automate:region:ec2:stop\n
\n arn:aws:automate:region:ec2:terminate\n
\n arn:aws:automate:region:ec2:reboot\n
\n arn:aws:automate:region:ec2:recover\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
\n Autoscaling action:\n
\n\n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n SSN notification action:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n SSM integration actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n
\n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n
The actions to execute when this alarm transitions to an OK state\n\t\t\tfrom any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:
\n EC2 actions:\n
\n\n arn:aws:automate:region:ec2:stop\n
\n arn:aws:automate:region:ec2:terminate\n
\n arn:aws:automate:region:ec2:reboot\n
\n arn:aws:automate:region:ec2:recover\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
\n Autoscaling action:\n
\n\n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n SNS notification action:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n SSM integration actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n
\n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n
The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN). Valid values:
\n EC2 actions:\n
\n\n arn:aws:automate:region:ec2:stop\n
\n arn:aws:automate:region:ec2:terminate\n
\n arn:aws:automate:region:ec2:reboot\n
\n arn:aws:automate:region:ec2:recover\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
\n Autoscaling action:\n
\n\n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n SSN notification action:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n SSM integration actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n
\n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n
The actions to execute when this alarm transitions to the ALARM state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN). Valid values:
\n EC2 actions:\n
\n\n arn:aws:automate:region:ec2:stop\n
\n arn:aws:automate:region:ec2:terminate\n
\n arn:aws:automate:region:ec2:reboot\n
\n arn:aws:automate:region:ec2:recover\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
\n Autoscaling action:\n
\n\n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n SNS notification action:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n SSM integration actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n
\n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN). Valid values:
\n EC2 actions:\n
\n\n arn:aws:automate:region:ec2:stop\n
\n arn:aws:automate:region:ec2:terminate\n
\n arn:aws:automate:region:ec2:reboot\n
\n arn:aws:automate:region:ec2:recover\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
\n Autoscaling action:\n
\n\n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n SSN notification action:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n SSM integration actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n
\n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. \n\t\t\tEach action is specified as an Amazon Resource Name (ARN). Valid values:
\n EC2 actions:\n
\n\n arn:aws:automate:region:ec2:stop\n
\n arn:aws:automate:region:ec2:terminate\n
\n arn:aws:automate:region:ec2:reboot\n
\n arn:aws:automate:region:ec2:recover\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0\n
\n arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0\n
\n Autoscaling action:\n
\n\n arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n SNS notification action:\n
\n\n arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name\n \n
\n SSM integration actions:\n
\n\n arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name\n \n
\n arn:aws:ssm-incidents::account-id:responseplan/response-plan-name\n \n
Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define\n questions related to agent performance, and create sections to organize such questions. An\n evaluation form must have a unique title within an instance. Question and section identifiers\n cannot be duplicated within the same evaluation form.
", + "smithy.api#documentation": "Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define\n questions related to agent performance, and create sections to organize such questions. Question and section identifiers\n cannot be duplicated within the same evaluation form.
", "smithy.api#http": { "method": "PUT", "uri": "/evaluation-forms/{InstanceId}", @@ -4296,7 +4296,7 @@ "Title": { "target": "com.amazonaws.connect#EvaluationFormTitle", "traits": { - "smithy.api#documentation": "A unique title of the evaluation form.
", + "smithy.api#documentation": "A title of the evaluation form.
", "smithy.api#required": {} } }, @@ -4683,9 +4683,6 @@ { "target": "com.amazonaws.connect#InternalServiceException" }, - { - "target": "com.amazonaws.connect#InvalidParameterException" - }, { "target": "com.amazonaws.connect#InvalidRequestException" }, @@ -9983,7 +9980,7 @@ "Title": { "target": "com.amazonaws.connect#EvaluationFormTitle", "traits": { - "smithy.api#documentation": "A unique title of the evaluation form.
", + "smithy.api#documentation": "A title of the evaluation form.
", "smithy.api#required": {} } }, @@ -10079,7 +10076,7 @@ "Title": { "target": "com.amazonaws.connect#EvaluationFormTitle", "traits": { - "smithy.api#documentation": "A unique title of the evaluation form.
", + "smithy.api#documentation": "A title of the evaluation form.
", "smithy.api#required": {} } }, @@ -10658,7 +10655,7 @@ "Title": { "target": "com.amazonaws.connect#EvaluationFormTitle", "traits": { - "smithy.api#documentation": "A unique title of the evaluation form.
", + "smithy.api#documentation": "A title of the evaluation form.
", "smithy.api#required": {} } }, @@ -10999,7 +10996,7 @@ "EvaluationFormTitle": { "target": "com.amazonaws.connect#EvaluationFormTitle", "traits": { - "smithy.api#documentation": "A unique title of the evaluation form.
", + "smithy.api#documentation": "A title of the evaluation form.
", "smithy.api#required": {} } }, @@ -17608,7 +17605,7 @@ } }, "traits": { - "smithy.api#documentation": "Information about the property value used in automation of a numeric questions. Label values\n are associated with minimum and maximum values for the numeric question.
\nSentiment scores have a minimum value of -5 and maximum value of 5.
\n Duration labels, such as NON_TALK_TIME, CONTACT_DURATION,\n AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value\n of 0 and maximum value of 28800.
Percantages have a minimum value of 0 and maximum value of 100.
\n\n NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of\n 100.
Information about the property value used in automation of a numeric questions. Label values\n are associated with minimum and maximum values for the numeric question.
\nSentiment scores have a minimum value of -5 and maximum value of 5.
\n Duration labels, such as NON_TALK_TIME, CONTACT_DURATION,\n AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME have a minimum value\n of 0 and maximum value of 28800.
Percentages have a minimum value of 0 and maximum value of 100.
\n\n NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of\n 1000.
The identifier of the answer option tha
", + "smithy.api#documentation": "The identifier of the answer option.
", "smithy.api#required": {} } } @@ -25645,7 +25642,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates details about a specific evaluation form version in the specified Amazon Connect\n instance. An evaluation form must have a unique title within an instance. Question and section\n identifiers cannot be duplicated within the same evaluation form.
\nThis operation does not support partial updates. Instead it does a full update of evaluation form content.
", + "smithy.api#documentation": "Updates details about a specific evaluation form version in the specified Amazon Connect\n instance. Question and section\n identifiers cannot be duplicated within the same evaluation form.
\nThis operation does not support partial updates. Instead it does a full update of evaluation form content.
", "smithy.api#http": { "method": "PUT", "uri": "/evaluation-forms/{InstanceId}/{EvaluationFormId}", @@ -25689,7 +25686,7 @@ "Title": { "target": "com.amazonaws.connect#EvaluationFormTitle", "traits": { - "smithy.api#documentation": "A unique title of the evaluation form.
", + "smithy.api#documentation": "A title of the evaluation form.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk-codegen/aws-models/ecs.json b/codegen/sdk-codegen/aws-models/ecs.json index 194e4ae1223..85456b84c21 100644 --- a/codegen/sdk-codegen/aws-models/ecs.json +++ b/codegen/sdk-codegen/aws-models/ecs.json @@ -2937,6 +2937,9 @@ { "target": "com.amazonaws.ecs#InvalidParameterException" }, + { + "target": "com.amazonaws.ecs#NamespaceNotFoundException" + }, { "target": "com.amazonaws.ecs#ServerException" } @@ -11112,6 +11115,9 @@ { "target": "com.amazonaws.ecs#InvalidParameterException" }, + { + "target": "com.amazonaws.ecs#NamespaceNotFoundException" + }, { "target": "com.amazonaws.ecs#ServerException" } diff --git a/codegen/sdk-codegen/aws-models/network-firewall.json b/codegen/sdk-codegen/aws-models/network-firewall.json index cc0ae1a257e..5f5c6ef95f1 100644 --- a/codegen/sdk-codegen/aws-models/network-firewall.json +++ b/codegen/sdk-codegen/aws-models/network-firewall.json @@ -328,28 +328,28 @@ "smithy.api#enumValue": "DELETING" } }, - "SCALING": { + "FAILED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "SCALING" + "smithy.api#enumValue": "FAILED" } }, - "READY": { + "ERROR": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "READY" + "smithy.api#enumValue": "ERROR" } }, - "FAILED": { + "SCALING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "FAILED" + "smithy.api#enumValue": "SCALING" } }, - "ERROR": { + "READY": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ERROR" + "smithy.api#enumValue": "READY" } } } @@ -4956,7 +4956,7 @@ "StatefulRules": { "target": "com.amazonaws.networkfirewall#StatefulRules", "traits": { - "smithy.api#documentation": "An array of individual stateful rules inspection criteria to be used together in a stateful rule group.\n Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options.\n For information about the Suricata Rules format, see\n Rules Format.
An array of individual stateful rules inspection criteria to be used together in a stateful rule group.\n Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options.\n For information about the Suricata Rules format, see\n Rules Format.
Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.
\n\n DROP - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.
\n CONTINUE - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to drop http traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a flow:stateless rule would still match, as would the aws:drop_strict default action.
Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.
\n\n DROP - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.
\n CONTINUE - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to drop http traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a flow:stateless rule would still match, as would the aws:drop_strict default action.
\n REJECT - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.
Defines what Network Firewall should do with the packets in a traffic flow when the flow\n matches the stateful rule criteria. For all actions, Network Firewall performs the specified\n action and discontinues stateful inspection of the traffic flow.
\nThe actions for a stateful rule are defined as follows:
\n\n PASS - Permits the packets to go to the\n intended destination.
\n\n DROP - Blocks the packets from going to\n the intended destination and sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.
\n\n ALERT - Permits the packets to go to the\n intended destination and sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.
\nYou can use this action to test a rule that you intend to use to drop traffic. You\n can enable the rule with ALERT action, verify in the logs that the rule\n is filtering as you want, then change the action to DROP.
Defines what Network Firewall should do with the packets in a traffic flow when the flow\n matches the stateful rule criteria. For all actions, Network Firewall performs the specified\n action and discontinues stateful inspection of the traffic flow.
\nThe actions for a stateful rule are defined as follows:
\n\n PASS - Permits the packets to go to the\n intended destination.
\n\n DROP - Blocks the packets from going to\n the intended destination and sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.
\n\n ALERT - Permits the packets to go to the\n intended destination and sends an alert log message, if alert logging is configured in the Firewall\n LoggingConfiguration.
\nYou can use this action to test a rule that you intend to use to drop traffic. You\n can enable the rule with ALERT action, verify in the logs that the rule\n is filtering as you want, then change the action to DROP.
\n REJECT - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a RST bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the Firewall\n LoggingConfiguration.
\n REJECT isn't currently available for use with IMAP and FTP protocols.
A single Suricata rules specification, for use in a stateful rule group.\n Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options.\n For information about the Suricata Rules format, see\n Rules Format.
A single Suricata rules specification, for use in a stateful rule group.\n Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options.\n For information about the Suricata Rules format, see\n Rules Format.
Key-value pairs to configure slow log publishing.
" + "smithy.api#documentation": "Key-value pairs to configure log publishing.
" } }, "DomainEndpointOptions": { @@ -3546,6 +3549,22 @@ "smithy.api#output": {} } }, + "com.amazonaws.opensearch#DependencyFailureException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.opensearch#ErrorMessage", + "traits": { + "smithy.api#documentation": "A description of the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An exception for when a failure in one of the dependencies results in the service being unable to fetch details about the resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 424 + } + }, "com.amazonaws.opensearch#DeploymentCloseDateTimeStamp": { "type": "timestamp" }, @@ -3983,6 +4002,75 @@ "smithy.api#output": {} } }, + "com.amazonaws.opensearch#DescribeDomainNodes": { + "type": "operation", + "input": { + "target": "com.amazonaws.opensearch#DescribeDomainNodesRequest" + }, + "output": { + "target": "com.amazonaws.opensearch#DescribeDomainNodesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.opensearch#BaseException" + }, + { + "target": "com.amazonaws.opensearch#DependencyFailureException" + }, + { + "target": "com.amazonaws.opensearch#DisabledOperationException" + }, + { + "target": "com.amazonaws.opensearch#InternalException" + }, + { + "target": "com.amazonaws.opensearch#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.opensearch#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about domain and nodes, including data nodes, master nodes, ultrawarm\n nodes, Availability Zone(s), standby nodes, node configurations, and node states.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2021-01-01/opensearch/domain/{DomainName}/nodes", + "code": 200 + } + } + }, + "com.amazonaws.opensearch#DescribeDomainNodesRequest": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.opensearch#DomainName", + "traits": { + "smithy.api#documentation": "The name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Container for the parameters to the DescribeDomainNodes\n operation.
Contains nodes information list DomainNodesStatusList with\n details about the all nodes on the requested domain.
The result of a DescribeDomainNodes request. Contains information about the nodes on the requested domain.
A list of values for the specified filter field.
" + "smithy.api#documentation": "A non-empty list of values for the specified filter field.
" } } }, @@ -4979,7 +5067,7 @@ "LogPublishingOptions": { "target": "com.amazonaws.opensearch#LogPublishingOptionsStatus", "traits": { - "smithy.api#documentation": "Key-value pairs to configure slow log publishing.
" + "smithy.api#documentation": "Key-value pairs to configure log publishing.
" } }, "DomainEndpointOptions": { @@ -5195,6 +5283,71 @@ "smithy.api#documentation": "A list of OpenSearch Service domain names.
" } }, + "com.amazonaws.opensearch#DomainNodesStatus": { + "type": "structure", + "members": { + "NodeId": { + "target": "com.amazonaws.opensearch#NodeId", + "traits": { + "smithy.api#documentation": "The ID of the node.
" + } + }, + "NodeType": { + "target": "com.amazonaws.opensearch#NodeType", + "traits": { + "smithy.api#documentation": "Indicates whether the nodes is a data, master, or ultrawarm node.
" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.opensearch#AvailabilityZone", + "traits": { + "smithy.api#documentation": "The Availability Zone of the node.
" + } + }, + "InstanceType": { + "target": "com.amazonaws.opensearch#OpenSearchPartitionInstanceType", + "traits": { + "smithy.api#documentation": "The instance type information of the node.
" + } + }, + "NodeStatus": { + "target": "com.amazonaws.opensearch#NodeStatus", + "traits": { + "smithy.api#documentation": "Indicates if the node is active or in standby.
" + } + }, + "StorageType": { + "target": "com.amazonaws.opensearch#StorageTypeName", + "traits": { + "smithy.api#documentation": "Indicates if the node has EBS or instance storage.
" + } + }, + "StorageVolumeType": { + "target": "com.amazonaws.opensearch#VolumeType", + "traits": { + "smithy.api#documentation": "If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable\n for data nodes.
" + } + }, + "StorageSize": { + "target": "com.amazonaws.opensearch#VolumeSize", + "traits": { + "smithy.api#documentation": "The storage size of the node, in GiB.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Container for information about nodes on the domain.
" + } + }, + "com.amazonaws.opensearch#DomainNodesStatusList": { + "type": "list", + "member": { + "target": "com.amazonaws.opensearch#DomainNodesStatus" + }, + "traits": { + "smithy.api#documentation": "List of DomainNodesStatus with details about nodes on\n the requested domain.
When nextToken is returned, there are more results available. The value of\n nextToken is a unique pagination token for each page. Make the call again using the\n returned token to retrieve the next page.
Status of the node-to-node encryption options for the specified domain.
" } }, + "com.amazonaws.opensearch#NodeType": { + "type": "enum", + "members": { + "Data": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Data" + } + }, + "Ultrawarm": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Ultrawarm" + } + }, + "Master": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Master" + } + } + } + }, "com.amazonaws.opensearch#NonEmptyString": { "type": "string", "traits": { @@ -10121,7 +10329,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
", + "smithy.api#documentation": "Modifies the cluster configuration of the specified Amazon OpenSearch Service\n domain.sl
", "smithy.api#http": { "method": "POST", "uri": "/2021-01-01/opensearch/domain/{DomainName}/config", @@ -10974,6 +11182,9 @@ "smithy.api#pattern": "^Elasticsearch_[0-9]{1}\\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\\.[0-9]{1,2}$" } }, + "com.amazonaws.opensearch#VolumeSize": { + "type": "string" + }, "com.amazonaws.opensearch#VolumeType": { "type": "enum", "members": { diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index 00a5fcfdc07..b37ca6ae3b8 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -242,6 +242,15 @@ "smithy.api#documentation": "An aggregation function aggregates values from a dimension or measure.
\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" } }, + "com.amazonaws.quicksight#AggregationFunctionParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#LimitedString" + }, + "value": { + "target": "com.amazonaws.quicksight#LimitedString" + } + }, "com.amazonaws.quicksight#AggregationSortConfiguration": { "type": "structure", "members": { @@ -1109,6 +1118,89 @@ } } }, + "com.amazonaws.quicksight#AuthorSpecifiedAggregation": { + "type": "enum", + "members": { + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + }, + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + }, + "PERCENTILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTILE" + } + } + } + }, + "com.amazonaws.quicksight#AuthorSpecifiedAggregations": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregation" + } + }, "com.amazonaws.quicksight#AwsAccountId": { "type": "string", "traits": { @@ -1835,6 +1927,22 @@ "smithy.api#documentation": "The configuration of content in a body section.
" } }, + "com.amazonaws.quicksight#BookmarksConfigurations": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean value that determines whether a user\n can bookmark an embedded dashboard.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The bookmarks configuration of an embedded dashboard.
" + } + }, "com.amazonaws.quicksight#Boolean": { "type": "boolean", "traits": { @@ -2175,7 +2283,7 @@ } }, "Expression": { - "target": "com.amazonaws.quicksight#Expression", + "target": "com.amazonaws.quicksight#CalculatedFieldExpression", "traits": { "smithy.api#documentation": "The expression of the calculated field.
", "smithy.api#required": {} @@ -2186,6 +2294,16 @@ "smithy.api#documentation": "The calculated field of an analysis.
" } }, + "com.amazonaws.quicksight#CalculatedFieldExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32000 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.quicksight#CalculatedFields": { "type": "list", "member": { @@ -2194,7 +2312,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 100 + "max": 500 } } }, @@ -2568,6 +2686,23 @@ "smithy.api#documentation": "The configuration for a CategoryFilter.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" } }, + "com.amazonaws.quicksight#CategoryFilterFunction": { + "type": "enum", + "members": { + "EXACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXACT" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + } + } + }, "com.amazonaws.quicksight#CategoryFilterMatchOperator": { "type": "enum", "members": { @@ -2620,6 +2755,29 @@ } } }, + "com.amazonaws.quicksight#CategoryFilterType": { + "type": "enum", + "members": { + "CUSTOM_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_FILTER" + } + }, + "CUSTOM_FILTER_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_FILTER_LIST" + } + }, + "FILTER_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILTER_LIST" + } + } + } + }, "com.amazonaws.quicksight#CategoryValue": { "type": "string", "traits": { @@ -2641,6 +2799,32 @@ } } }, + "com.amazonaws.quicksight#CellValueSynonym": { + "type": "structure", + "members": { + "CellValue": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The cell value.
" + } + }, + "Synonyms": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "Other names or aliases for the cell value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents the cell value synonym.
" + } + }, + "com.amazonaws.quicksight#CellValueSynonyms": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CellValueSynonym" + } + }, "com.amazonaws.quicksight#ChartAxisLabelOptions": { "type": "structure", "members": { @@ -2704,6 +2888,20 @@ "smithy.api#documentation": "The cluster marker configuration of the geospatial map selected point style.
" } }, + "com.amazonaws.quicksight#CollectiveConstant": { + "type": "structure", + "members": { + "ValueList": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "A list of values for the collective constant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a collective constant.
" + } + }, "com.amazonaws.quicksight#ColorFillType": { "type": "enum", "members": { @@ -2812,6 +3010,23 @@ } } }, + "com.amazonaws.quicksight#ColumnDataRole": { + "type": "enum", + "members": { + "DIMENSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIMENSION" + } + }, + "MEASURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEASURE" + } + } + } + }, "com.amazonaws.quicksight#ColumnDataType": { "type": "enum", "members": { @@ -3089,6 +3304,29 @@ } } }, + "com.amazonaws.quicksight#ColumnOrderingType": { + "type": "enum", + "members": { + "GREATER_IS_BETTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_IS_BETTER" + } + }, + "LESSER_IS_BETTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESSER_IS_BETTER" + } + }, + "SPECIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPECIFIED" + } + } + } + }, "com.amazonaws.quicksight#ColumnRole": { "type": "enum", "members": { @@ -3486,6 +3724,32 @@ "smithy.api#documentation": "A combo chart.
\nThe ComboChartVisual includes stacked bar combo charts and clustered bar combo charts
For more information, see Using combo charts in the Amazon QuickSight User Guide.
" } }, + "com.amazonaws.quicksight#ComparativeOrder": { + "type": "structure", + "members": { + "UseOrdering": { + "target": "com.amazonaws.quicksight#ColumnOrderingType", + "traits": { + "smithy.api#documentation": "The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.
The list of columns to be used in the ordering.
" + } + }, + "TreatUndefinedSpecifiedValues": { + "target": "com.amazonaws.quicksight#UndefinedSpecifiedValueType", + "traits": { + "smithy.api#documentation": "The treat of undefined specified values. Valid values for this structure are LEAST and MOST.
A structure that represents a comparative order.
" + } + }, "com.amazonaws.quicksight#ComparisonConfiguration": { "type": "structure", "members": { @@ -3918,6 +4182,29 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.quicksight#ConstantType": { + "type": "enum", + "members": { + "SINGULAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGULAR" + } + }, + "RANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANGE" + } + }, + "COLLECTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLLECTIVE" + } + } + } + }, "com.amazonaws.quicksight#ContributionAnalysisDefault": { "type": "structure", "members": { @@ -4741,6 +5028,12 @@ }, "DataSetUsageConfiguration": { "target": "com.amazonaws.quicksight#DataSetUsageConfiguration" + }, + "DatasetParameters": { + "target": "com.amazonaws.quicksight#DatasetParameterList", + "traits": { + "smithy.api#documentation": "The parameter declarations of the dataset.
" + } } }, "traits": { @@ -5446,7 +5739,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name\n\t\t\t(ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight.\n\t\t\tAssignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces,\n\t\t\tuse assignment names that are unique.
", + "smithy.api#documentation": "Creates an assignment with one specified IAM policy, identified by its\n\t\t\tAmazon Resource Name (ARN). This policy assignment is attached to the specified groups\n\t\t\tor users of Amazon QuickSight. Assignment names are unique per Amazon Web Services\n\t\t\taccount. To avoid overwriting rules in other namespaces, use assignment names that are\n\t\t\tunique.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments", @@ -5460,7 +5753,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or\n\t\t\tgroups.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5468,27 +5761,27 @@ "AssignmentName": { "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { - "smithy.api#documentation": "The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account.
", + "smithy.api#documentation": "The name of the assignment, also called a rule.\n\t\t\tThe\n\t\t\tname\n\t\t\tmust be unique within the\n\t\t\tAmazon Web Services account.
", "smithy.api#required": {} } }, "AssignmentStatus": { "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "The status of the assignment. Possible values are as follows:
\n\n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\t\tsource.
\n DISABLED - This assignment isn't used when creating the data source.
\n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\t\tdata source.
The status of the assignment. Possible values are as follows:
\n\n ENABLED - Anything specified in this assignment is used when\n\t\t\t\t\tcreating the data source.
\n DISABLED - This assignment isn't used when creating the data\n\t\t\t\t\tsource.
\n DRAFT - This assignment is an unfinished draft and isn't used\n\t\t\t\t\twhen creating the data source.
The ARN for the IAM policy to apply to the Amazon QuickSight users and groups\n\t\t\tspecified in this assignment.
" + "smithy.api#documentation": "The ARN for the IAM policy to apply to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.
" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "The Amazon QuickSight users, groups, or both that you want to assign the policy to.
" + "smithy.api#documentation": "The Amazon QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.
" } }, "Namespace": { @@ -5510,7 +5803,7 @@ "AssignmentName": { "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { - "smithy.api#documentation": "The name of the assignment. This name must be unique within the Amazon Web Services account.
" + "smithy.api#documentation": "The name of the assignment.\n\t\t\tThe\n\t\t\tname must be unique within the Amazon Web Services account.
" } }, "AssignmentId": { @@ -5522,19 +5815,19 @@ "AssignmentStatus": { "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "The status of the assignment. Possible values are as follows:
\n\n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.
\n DISABLED - This assignment isn't used when creating the data source.
\n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.
The status of the assignment. Possible values are as follows:
\n\n ENABLED - Anything specified in this assignment is used when\n\t\t\t\t\tcreating the data source.
\n DISABLED - This assignment isn't used when creating the data\n\t\t\t\t\tsource.
\n DRAFT - This assignment is an unfinished draft and isn't used\n\t\t\t\t\twhen creating the data source.
The ARN for the IAM policy that is applied to the Amazon QuickSight users and groups specified in this assignment.
" + "smithy.api#documentation": "The ARN for the IAM policy that is applied to the Amazon QuickSight\n\t\t\tusers and groups specified in this assignment.
" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
" + "smithy.api#documentation": "The Amazon QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.
" } }, "RequestId": { @@ -6440,248 +6733,658 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#CredentialPair": { - "type": "structure", - "members": { - "Username": { - "target": "com.amazonaws.quicksight#UserName2", - "traits": { - "smithy.api#documentation": "User name.
", - "smithy.api#required": {} - } + "com.amazonaws.quicksight#CreateTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateTopicRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "Password": { - "target": "com.amazonaws.quicksight#Password", - "traits": { - "smithy.api#documentation": "Password.
", - "smithy.api#required": {} - } + { + "target": "com.amazonaws.quicksight#ConflictException" }, - "AlternateDataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParametersList", - "traits": { - "smithy.api#documentation": "A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares\n the DataSourceParameters structure that's in the request with the\n structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the new data source with\n the existing credentials. If the AlternateDataSourceParameters list is\n null, the DataSourceParameters originally used with these\n Credentials is automatically allowed.
The combination of user name and password that are used as credentials.
" + "smithy.api#documentation": "Creates a new Q topic.
", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/topics", + "code": 200 + } } }, - "com.amazonaws.quicksight#CrossDatasetTypes": { - "type": "enum", - "members": { - "ALL_DATASETS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_DATASETS" - } + "com.amazonaws.quicksight#CreateTopicRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateTopicRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateTopicRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "SINGLE_DATASET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_DATASET" - } + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" } - } - }, - "com.amazonaws.quicksight#CurrencyCode": { - "type": "string", + ], "traits": { - "smithy.api#pattern": "^[A-Z]{3}$" + "smithy.api#documentation": "Creates a topic refresh schedule.
", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules", + "code": 200 + } } }, - "com.amazonaws.quicksight#CurrencyDisplayFormatConfiguration": { + "com.amazonaws.quicksight#CreateTopicRefreshScheduleRequest": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.quicksight#Prefix", - "traits": { - "smithy.api#documentation": "Determines the prefix value of the currency format.
" - } - }, - "Suffix": { - "target": "com.amazonaws.quicksight#Suffix", - "traits": { - "smithy.api#documentation": "Determines the suffix value of the currency format.
" - } - }, - "SeparatorConfiguration": { - "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", - "traits": { - "smithy.api#documentation": "The options that determine the numeric separator configuration.
" - } - }, - "Symbol": { - "target": "com.amazonaws.quicksight#CurrencyCode", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "Determines the symbol for the currency format.
" + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the topic\n you're creating a refresh schedule for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "DecimalPlacesConfiguration": { - "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#documentation": "The option that determines the decimal places configuration.
" + "smithy.api#documentation": "The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "NumberScale": { - "target": "com.amazonaws.quicksight#NumberScale", + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "Determines the number scale value for the currency format.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
", + "smithy.api#required": {} } }, - "NegativeValueConfiguration": { - "target": "com.amazonaws.quicksight#NegativeValueConfiguration", + "DatasetName": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The options that determine the negative value configuration.
" + "smithy.api#documentation": "The name of the dataset.
" } }, - "NullValueFormatConfiguration": { - "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#TopicRefreshSchedule", "traits": { - "smithy.api#documentation": "The options that determine the null value format configuration.
" + "smithy.api#documentation": "The definition of a refresh schedule.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The options that determine the currency display format configuration.
" + "smithy.api#input": {} } }, - "com.amazonaws.quicksight#CustomActionFilterOperation": { + "com.amazonaws.quicksight#CreateTopicRefreshScheduleResponse": { "type": "structure", "members": { - "SelectedFieldsConfiguration": { - "target": "com.amazonaws.quicksight#FilterOperationSelectedFieldsConfiguration", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#documentation": "The configuration that chooses the fields to be filtered.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, - "TargetVisualsConfiguration": { - "target": "com.amazonaws.quicksight#FilterOperationTargetVisualsConfiguration", + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The configuration that chooses the target visuals to be filtered.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic.
" } - } - }, - "traits": { - "smithy.api#documentation": "The filter operation that filters data included in a visual or in an entire sheet.
" - } - }, - "com.amazonaws.quicksight#CustomActionNavigationOperation": { - "type": "structure", - "members": { - "LocalNavigationConfiguration": { - "target": "com.amazonaws.quicksight#LocalNavigationConfiguration", + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The configuration that chooses the navigation target.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" } - } - }, - "traits": { - "smithy.api#documentation": "The navigation operation that navigates between different sheets in the same analysis.
\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" - } - }, - "com.amazonaws.quicksight#CustomActionSetParametersOperation": { - "type": "structure", - "members": { - "ParameterValueConfigurations": { - "target": "com.amazonaws.quicksight#SetParameterValueConfigurationList", + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The parameter that determines the value configuration.
", - "smithy.api#required": {} + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } } }, "traits": { - "smithy.api#documentation": "The set parameter operation that sets parameters in custom action.
" + "smithy.api#output": {} } }, - "com.amazonaws.quicksight#CustomActionURLOperation": { + "com.amazonaws.quicksight#CreateTopicRequest": { "type": "structure", "members": { - "URLTemplate": { - "target": "com.amazonaws.quicksight#URLOperationTemplate", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "THe URL link of the CustomActionURLOperation.
The ID of the Amazon Web Services account that you want to create a topic in.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "URLTarget": { - "target": "com.amazonaws.quicksight#URLTargetConfiguration", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#documentation": "The target of the CustomActionURLOperation.
Valid values are defined as follows:
\n\n NEW_TAB: Opens the target URL in a new browser tab.
\n NEW_WINDOW: Opens the target URL in a new browser window.
\n SAME_TAB: Opens the target URL in the same browser tab.
The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#required": {} } - } - }, - "traits": { - "smithy.api#documentation": "The URL operation that opens a link to another webpage.
" - } - }, - "com.amazonaws.quicksight#CustomContentConfiguration": { - "type": "structure", - "members": { - "ContentUrl": { - "target": "com.amazonaws.quicksight#URLOperationTemplate", - "traits": { - "smithy.api#documentation": "The input URL that links to the custom content that you want in the custom visual.
" - } }, - "ContentType": { - "target": "com.amazonaws.quicksight#CustomContentType", + "Topic": { + "target": "com.amazonaws.quicksight#TopicDetails", "traits": { - "smithy.api#documentation": "The content type of the custom content visual. You can use this to have the visual render as an image.
" + "smithy.api#documentation": "The definition of a topic to create.
", + "smithy.api#required": {} } }, - "ImageScaling": { - "target": "com.amazonaws.quicksight#CustomContentImageScalingConfiguration", + "Tags": { + "target": "com.amazonaws.quicksight#TagList", "traits": { - "smithy.api#documentation": "The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.
Contains a map of the key-value pairs for the resource tag or tags that are assigned to\n the dataset.
" } } }, "traits": { - "smithy.api#documentation": "The configuration of a CustomContentVisual.
The Amazon Resource Name (ARN) of the topic.
" } }, - "FIT_TO_WIDTH": { - "target": "smithy.api#Unit", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#enumValue": "FIT_TO_WIDTH" + "smithy.api#documentation": "The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region\n for each Amazon Web Services account.
" } }, - "DO_NOT_SCALE": { - "target": "smithy.api#Unit", + "RefreshArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#enumValue": "DO_NOT_SCALE" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic refresh.
" } }, - "SCALE_TO_VISUAL": { - "target": "smithy.api#Unit", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#enumValue": "SCALE_TO_VISUAL" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } + }, + "traits": { + "smithy.api#output": {} } }, - "com.amazonaws.quicksight#CustomContentType": { - "type": "enum", - "members": { - "IMAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMAGE" + "com.amazonaws.quicksight#CreateVPCConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateVPCConnectionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateVPCConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new VPC connection.
", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/vpc-connections", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateVPCConnectionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the account where you want to create a new VPC\n\t\t\tconnection.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted", + "traits": { + "smithy.api#documentation": "The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "The display name for the VPC connection.
", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.quicksight#SubnetIdList", + "traits": { + "smithy.api#documentation": "A list of subnet IDs for the VPC connection.
", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "A list of security group IDs for the VPC connection.
", + "smithy.api#required": {} + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#DnsResolverList", + "traits": { + "smithy.api#documentation": "A list of IP addresses of DNS resolver endpoints for the VPC connection.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "The IAM role to associate with the VPC connection.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "A map of the key-value pairs for the resource tag or tags assigned to the VPC\n\t\t\tconnection.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateVPCConnectionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the VPC connection.
" + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted", + "traits": { + "smithy.api#documentation": "The ID for the VPC connection that\n\t\t\tyou're creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services\n\t\t\taccount.
" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "The status of the creation of the VPC connection.
" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "The availability status of the VPC connection.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CredentialPair": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.quicksight#UserName2", + "traits": { + "smithy.api#documentation": "User name.
", + "smithy.api#required": {} + } + }, + "Password": { + "target": "com.amazonaws.quicksight#Password", + "traits": { + "smithy.api#documentation": "Password.
", + "smithy.api#required": {} + } + }, + "AlternateDataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParametersList", + "traits": { + "smithy.api#documentation": "A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares\n the DataSourceParameters structure that's in the request with the\n structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the new data source with\n the existing credentials. If the AlternateDataSourceParameters list is\n null, the DataSourceParameters originally used with these\n Credentials is automatically allowed.
The combination of user name and password that are used as credentials.
" + } + }, + "com.amazonaws.quicksight#CrossDatasetTypes": { + "type": "enum", + "members": { + "ALL_DATASETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_DATASETS" + } + }, + "SINGLE_DATASET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_DATASET" + } + } + } + }, + "com.amazonaws.quicksight#CurrencyCode": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Z]{3}$" + } + }, + "com.amazonaws.quicksight#CurrencyDisplayFormatConfiguration": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.quicksight#Prefix", + "traits": { + "smithy.api#documentation": "Determines the prefix value of the currency format.
" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#Suffix", + "traits": { + "smithy.api#documentation": "Determines the suffix value of the currency format.
" + } + }, + "SeparatorConfiguration": { + "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", + "traits": { + "smithy.api#documentation": "The options that determine the numeric separator configuration.
" + } + }, + "Symbol": { + "target": "com.amazonaws.quicksight#CurrencyCode", + "traits": { + "smithy.api#documentation": "Determines the symbol for the currency format.
" + } + }, + "DecimalPlacesConfiguration": { + "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", + "traits": { + "smithy.api#documentation": "The option that determines the decimal places configuration.
" + } + }, + "NumberScale": { + "target": "com.amazonaws.quicksight#NumberScale", + "traits": { + "smithy.api#documentation": "Determines the number scale value for the currency format.
" + } + }, + "NegativeValueConfiguration": { + "target": "com.amazonaws.quicksight#NegativeValueConfiguration", + "traits": { + "smithy.api#documentation": "The options that determine the negative value configuration.
" + } + }, + "NullValueFormatConfiguration": { + "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", + "traits": { + "smithy.api#documentation": "The options that determine the null value format configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The options that determine the currency display format configuration.
" + } + }, + "com.amazonaws.quicksight#CustomActionColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#CustomActionFilterOperation": { + "type": "structure", + "members": { + "SelectedFieldsConfiguration": { + "target": "com.amazonaws.quicksight#FilterOperationSelectedFieldsConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that chooses the fields to be filtered.
", + "smithy.api#required": {} + } + }, + "TargetVisualsConfiguration": { + "target": "com.amazonaws.quicksight#FilterOperationTargetVisualsConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that chooses the target visuals to be filtered.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The filter operation that filters data included in a visual or in an entire sheet.
" + } + }, + "com.amazonaws.quicksight#CustomActionNavigationOperation": { + "type": "structure", + "members": { + "LocalNavigationConfiguration": { + "target": "com.amazonaws.quicksight#LocalNavigationConfiguration", + "traits": { + "smithy.api#documentation": "The configuration that chooses the navigation target.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The navigation operation that navigates between different sheets in the same analysis.
\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" + } + }, + "com.amazonaws.quicksight#CustomActionSetParametersOperation": { + "type": "structure", + "members": { + "ParameterValueConfigurations": { + "target": "com.amazonaws.quicksight#SetParameterValueConfigurationList", + "traits": { + "smithy.api#documentation": "The parameter that determines the value configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The set parameter operation that sets parameters in custom action.
" + } + }, + "com.amazonaws.quicksight#CustomActionURLOperation": { + "type": "structure", + "members": { + "URLTemplate": { + "target": "com.amazonaws.quicksight#URLOperationTemplate", + "traits": { + "smithy.api#documentation": "THe URL link of the CustomActionURLOperation.
The target of the CustomActionURLOperation.
Valid values are defined as follows:
\n\n NEW_TAB: Opens the target URL in a new browser tab.
\n NEW_WINDOW: Opens the target URL in a new browser window.
\n SAME_TAB: Opens the target URL in the same browser tab.
The URL operation that opens a link to another webpage.
" + } + }, + "com.amazonaws.quicksight#CustomContentConfiguration": { + "type": "structure", + "members": { + "ContentUrl": { + "target": "com.amazonaws.quicksight#URLOperationTemplate", + "traits": { + "smithy.api#documentation": "The input URL that links to the custom content that you want in the custom visual.
" + } + }, + "ContentType": { + "target": "com.amazonaws.quicksight#CustomContentType", + "traits": { + "smithy.api#documentation": "The content type of the custom content visual. You can use this to have the visual render as an image.
" + } + }, + "ImageScaling": { + "target": "com.amazonaws.quicksight#CustomContentImageScalingConfiguration", + "traits": { + "smithy.api#documentation": "The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.
The configuration of a CustomContentVisual.
The visual publish options of a visual in a dashboard
" } }, + "com.amazonaws.quicksight#DataAggregation": { + "type": "structure", + "members": { + "DatasetRowDateGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "The level of time precision that is used to aggregate DateTime values.
The column name for the default date.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a data aggregation.
" + } + }, "com.amazonaws.quicksight#DataBarsOptions": { "type": "structure", "members": { @@ -7790,6 +8513,12 @@ "traits": { "smithy.api#documentation": "Determines whether overlap is enabled or disabled for the data labels.
" } + }, + "TotalsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "Determines the visibility of the total.
" + } } }, "traits": { @@ -8167,6 +8896,12 @@ "traits": { "smithy.api#documentation": "The usage configuration to apply to child datasets that reference this dataset as a source.
" } + }, + "DatasetParameters": { + "target": "com.amazonaws.quicksight#DatasetParameterList", + "traits": { + "smithy.api#documentation": "The parameters that are declared in a dataset.
" + } } }, "traits": { @@ -9198,6 +9933,150 @@ "smithy.api#documentation": "The required parameters that are needed to connect to a Databricks data source.
" } }, + "com.amazonaws.quicksight#DatasetMetadata": { + "type": "structure", + "members": { + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
", + "smithy.api#required": {} + } + }, + "DatasetName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The name of the dataset.
" + } + }, + "DatasetDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The description of the dataset.
" + } + }, + "DataAggregation": { + "target": "com.amazonaws.quicksight#DataAggregation", + "traits": { + "smithy.api#documentation": "The definition of a data aggregation.
" + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#TopicFilters", + "traits": { + "smithy.api#documentation": "The list of filter definitions.
" + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#TopicColumns", + "traits": { + "smithy.api#documentation": "The list of column definitions.
" + } + }, + "CalculatedFields": { + "target": "com.amazonaws.quicksight#TopicCalculatedFields", + "traits": { + "smithy.api#documentation": "The list of calculated field definitions.
" + } + }, + "NamedEntities": { + "target": "com.amazonaws.quicksight#TopicNamedEntities", + "traits": { + "smithy.api#documentation": "The list of named entities definitions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a dataset.
" + } + }, + "com.amazonaws.quicksight#DatasetParameter": { + "type": "structure", + "members": { + "StringDatasetParameter": { + "target": "com.amazonaws.quicksight#StringDatasetParameter", + "traits": { + "smithy.api#documentation": "A string parameter that is created in the dataset.
" + } + }, + "DecimalDatasetParameter": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameter", + "traits": { + "smithy.api#documentation": "A decimal parameter that is created in the dataset.
" + } + }, + "IntegerDatasetParameter": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameter", + "traits": { + "smithy.api#documentation": "An integer parameter that is created in the dataset.
" + } + }, + "DateTimeDatasetParameter": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameter", + "traits": { + "smithy.api#documentation": "A date time parameter that is created in the dataset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A dataset parameter.
" + } + }, + "com.amazonaws.quicksight#DatasetParameterId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.quicksight#DatasetParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DatasetParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#DatasetParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.quicksight#DatasetParameterValueType": { + "type": "enum", + "members": { + "MULTI_VALUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_VALUED" + } + }, + "SINGLE_VALUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_VALUED" + } + } + } + }, + "com.amazonaws.quicksight#Datasets": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DatasetMetadata" + } + }, "com.amazonaws.quicksight#DateAggregationFunction": { "type": "enum", "members": { @@ -9315,6 +10194,79 @@ "smithy.api#documentation": "The measure type field with date type columns.
" } }, + "com.amazonaws.quicksight#DateTimeDatasetParameter": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.quicksight#DatasetParameterId", + "traits": { + "smithy.api#documentation": "An identifier for the parameter that is created in the dataset.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "The name of the date time parameter that is created in the dataset.
", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.quicksight#DatasetParameterValueType", + "traits": { + "smithy.api#documentation": "The value type of the dataset parameter. Valid values are single value or multi value.
The time granularity of the date time parameter.
" + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValues", + "traits": { + "smithy.api#documentation": "A list of default values for a given date time parameter. This structure only accepts static values.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A date time parameter for a dataset.
" + } + }, + "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValue": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "The default value for the date time parameter.
" + } + }, + "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValues": { + "type": "structure", + "members": { + "StaticValues": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "A list of static default values for a given date time parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default values of a date time parameter.
" + } + }, + "com.amazonaws.quicksight#DateTimeDatasetParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, "com.amazonaws.quicksight#DateTimeDefaultValueList": { "type": "list", "member": { @@ -9458,6 +10410,9 @@ "traits": { "smithy.api#documentation": "The configuration that defines the default value of a DateTime parameter when a value has not been set.
An identifier for the decimal parameter created in the dataset.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "The name of the decimal parameter that is created in the dataset.
", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.quicksight#DatasetParameterValueType", + "traits": { + "smithy.api#documentation": "The value type of the dataset parameter. Valid values are single value or multi value.
A list of default values for a given decimal parameter. This structure only accepts static values.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A decimal parameter for a dataset.
" + } + }, + "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValue": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The default value for the decimal parameter.
" + } + }, + "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValues": { + "type": "structure", + "members": { + "StaticValues": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "A list of static default values for a given decimal parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default values of a decimal parameter.
" + } + }, + "com.amazonaws.quicksight#DecimalDatasetParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, "com.amazonaws.quicksight#DecimalDefaultValueList": { "type": "list", "member": { @@ -9655,6 +10678,9 @@ "traits": { "smithy.api#documentation": "The configuration that defines the default value of a Decimal parameter when a value has not been set.
The configuration that defines the default value of a Decimal parameter when a value has not been set.
The display format. Valid values for this structure are AUTO,\n PERCENT, CURRENCY, NUMBER, DATE, and\n STRING.
The additional options for display formatting.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a default formatting definition.
" + } + }, "com.amazonaws.quicksight#DefaultFreeFormLayoutConfiguration": { "type": "structure", "members": { @@ -10915,7 +12002,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID where you want to delete the IAM policy assignment.
", + "smithy.api#documentation": "The Amazon Web Services account ID where you want to delete the IAM\n\t\t\tpolicy assignment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -11583,6 +12670,216 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DeleteTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteTopicRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a topic.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteTopicRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteTopicRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteTopicRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a topic refresh schedule.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteTopicRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DatasetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteTopicRefreshScheduleResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteTopicRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the topic that you want to\n delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteTopicResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic.
" + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DeleteUser": { "type": "operation", "input": { @@ -11772,6 +13069,116 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DeleteVPCConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteVPCConnectionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteVPCConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a VPC connection.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteVPCConnectionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the account where you want to delete a VPC\n\t\t\tconnection.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteVPCConnectionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted VPC connection.
" + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.
" + } + }, + "DeletionStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "The deletion status of the VPC connection.
" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "The availability status of the VPC connection.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#Delimiter": { "type": "string", "traits": { @@ -13706,7 +15113,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes an existing IAM policy assignment, as specified by the assignment name.
", + "smithy.api#documentation": "Describes an existing IAM policy assignment, as specified by the\n\t\t\tassignment name.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}", @@ -13720,7 +15127,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the assignment that you want to describe.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the assignment that you want to\n\t\t\tdescribe.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -13952,7 +15359,7 @@ "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#documentation": "The HTTP status of the request.\n\t\t\t
", "smithy.api#httpResponseCode": {} } } @@ -14897,6 +16304,417 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DescribeTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTopicRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a topic.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTopicPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTopicPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTopicPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the permissions of a topic.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTopicPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the topic that you want\n described.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicPermissionsResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic.
" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "A list of resource permissions that are configured to the topic.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRefresh": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the status of a topic refresh.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/refresh/{RefreshId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the topic whose refresh you want\n to describe.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RefreshId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the refresh, which is performed when the topic is created or updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshResponse": { + "type": "structure", + "members": { + "RefreshDetails": { + "target": "com.amazonaws.quicksight#TopicRefreshDetails", + "traits": { + "smithy.api#documentation": "Details of the refresh, which is performed when the topic is created or updated.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a topic refresh schedule.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "The ID of the topic that contains the refresh schedule that you want to describe. This\n ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DatasetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshScheduleResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "The ID of the topic that contains the refresh schedule that you want to describe. This\n ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic.
" + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#TopicRefreshSchedule", + "traits": { + "smithy.api#documentation": "The definition of a refresh schedule.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic.
" + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" + } + }, + "Topic": { + "target": "com.amazonaws.quicksight#TopicDetails", + "traits": { + "smithy.api#documentation": "The definition of a topic.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DescribeUser": { "type": "operation", "input": { @@ -14997,6 +16815,94 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#DescribeVPCConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeVPCConnectionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeVPCConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "Describes a VPC connection.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeVPCConnectionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the account that contains the VPC connection that\n\t\t\tyou want described.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeVPCConnectionResponse": { + "type": "structure", + "members": { + "VPCConnection": { + "target": "com.amazonaws.quicksight#VPCConnection", + "traits": { + "smithy.api#documentation": "A response object that provides information for the specified VPC connection.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#DestinationParameterValueConfiguration": { "type": "structure", "members": { @@ -15023,6 +16929,9 @@ "traits": { "smithy.api#documentation": "The source field ID of the destination parameter.
" } + }, + "SourceColumn": { + "target": "com.amazonaws.quicksight#ColumnIdentifier" } }, "traits": { @@ -15067,6 +16976,142 @@ } } }, + "com.amazonaws.quicksight#DisplayFormat": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT" + } + }, + "CURRENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURRENCY" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + } + } + }, + "com.amazonaws.quicksight#DisplayFormatOptions": { + "type": "structure", + "members": { + "UseBlankCellFormat": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean value that indicates whether to use blank cell format.
" + } + }, + "BlankCellFormat": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "Determines the blank cell format.
" + } + }, + "DateFormat": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "Determines the DateTime format.
Determines the decimal separator.
" + } + }, + "GroupingSeparator": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "Determines the grouping separator.
" + } + }, + "UseGrouping": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean value that indicates whether to use grouping.
" + } + }, + "FractionDigits": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "Determines the number of fraction digits.
" + } + }, + "Prefix": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The prefix value for a display format.
" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The suffix value for a display format.
" + } + }, + "UnitScaler": { + "target": "com.amazonaws.quicksight#NumberScale", + "traits": { + "smithy.api#documentation": "The unit scaler. Valid values for this structure are: NONE,\n AUTO, THOUSANDS, MILLIONS,\n BILLIONS,\n and TRILLIONS.
The negative format.
" + } + }, + "CurrencySymbol": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The currency symbol, such as USD.
A structure that represents additional options for display formatting.
" + } + }, + "com.amazonaws.quicksight#DnsResolverList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#IPv4Address" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + } + } + }, "com.amazonaws.quicksight#Domain": { "type": "string", "traits": { @@ -16121,6 +18166,29 @@ "smithy.api#documentation": "With a Filter, you can remove portions of data from a particular visual or view.
This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" } }, + "com.amazonaws.quicksight#FilterClass": { + "type": "enum", + "members": { + "ENFORCED_VALUE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENFORCED_VALUE_FILTER" + } + }, + "CONDITIONAL_VALUE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONDITIONAL_VALUE_FILTER" + } + }, + "NAMED_VALUE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMED_VALUE_FILTER" + } + } + } + }, "com.amazonaws.quicksight#FilterControl": { "type": "structure", "members": { @@ -16475,6 +18543,12 @@ "traits": { "smithy.api#documentation": "A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation.
Valid values are defined as follows:
\n\n ALL_FIELDS: Applies the filter operation to all fields.
The selected columns of a dataset.
" + } } }, "traits": { @@ -19876,6 +21950,15 @@ "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummary" } }, + "com.amazonaws.quicksight#IPv4Address": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 15 + } + } + }, "com.amazonaws.quicksight#Icon": { "type": "enum", "members": { @@ -20769,6 +22852,74 @@ "smithy.api#default": 0 } }, + "com.amazonaws.quicksight#IntegerDatasetParameter": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.quicksight#DatasetParameterId", + "traits": { + "smithy.api#documentation": "An identifier for the integer parameter created in the dataset.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "The name of the integer parameter that is created in the dataset.
", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.quicksight#DatasetParameterValueType", + "traits": { + "smithy.api#documentation": "The value type of the dataset parameter. Valid values are single value or multi value.
A list of default values for a given integer parameter. This structure only accepts static values.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An integer parameter for a dataset.
" + } + }, + "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValue": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The default value for the integer parameter.
" + } + }, + "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValues": { + "type": "structure", + "members": { + "StaticValues": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "A list of static default values for a given integer parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default values of an integer parameter.
" + } + }, + "com.amazonaws.quicksight#IntegerDatasetParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, "com.amazonaws.quicksight#IntegerDefaultValueList": { "type": "list", "member": { @@ -20851,6 +23002,9 @@ "traits": { "smithy.api#documentation": "A parameter declaration for the Integer data type.
Lists IAM policy assignments in the current Amazon QuickSight account.
", + "smithy.api#documentation": "Lists the\n\t\t\tIAM policy assignments in the current Amazon QuickSight\n\t\t\taccount.
", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/v2/iam-policy-assignments", "code": 200 } } @@ -23184,7 +25347,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM\n\t\t\tpolicies assigned to the specified user and group or groups that the user belongs\n\t\t\tto.
", + "smithy.api#documentation": "Lists all of\n\t\t\tthe IAM policy assignments, including the Amazon\n\t\t\tResource Names\n\t\t\t(ARNs),\n\t\t\tfor the IAM policies assigned to the specified user and\n\t\t\tgroup,\n\t\t\tor groups that the user belongs to.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/iam-policy-assignments", @@ -23279,7 +25442,7 @@ "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that contains these IAM policy assignments.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains these IAM policy\n\t\t\tassignments.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -23287,7 +25450,8 @@ "AssignmentStatus": { "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "The status of the assignments.
" + "smithy.api#documentation": "The status of the assignments.
", + "smithy.api#httpQuery": "assignment-status" } }, "Namespace": { @@ -24439,18 +26603,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#ListUserGroups": { + "com.amazonaws.quicksight#ListTopicRefreshSchedules": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#ListUserGroupsRequest" + "target": "com.amazonaws.quicksight#ListTopicRefreshSchedulesRequest" }, "output": { - "target": "com.amazonaws.quicksight#ListUserGroupsResponse" + "target": "com.amazonaws.quicksight#ListTopicRefreshSchedulesResponse" }, "errors": [ { "target": "com.amazonaws.quicksight#AccessDeniedException" }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, { "target": "com.amazonaws.quicksight#InternalFailureException" }, @@ -24458,93 +26625,70 @@ "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" + "target": "com.amazonaws.quicksight#LimitExceededException" }, { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" + "target": "com.amazonaws.quicksight#ResourceExistsException" }, { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, { "target": "com.amazonaws.quicksight#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
", + "smithy.api#documentation": "Lists all of the refresh schedules for a topic.
", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules", "code": 200 } } }, - "com.amazonaws.quicksight#ListUserGroupsRequest": { + "com.amazonaws.quicksight#ListTopicRefreshSchedulesRequest": { "type": "structure", "members": { - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "The Amazon QuickSight user name that you want to list group memberships for.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account\n\t\t\tthat contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the topic whose refresh schedule\n you want described.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#documentation": "The namespace. Currently, you should set this to default.
The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "The maximum number of results to return from this request.
", - "smithy.api#httpQuery": "max-results" - } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.quicksight#ListUserGroupsResponse": { + "com.amazonaws.quicksight#ListTopicRefreshSchedulesResponse": { "type": "structure", "members": { - "GroupList": { - "target": "com.amazonaws.quicksight#GroupList", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#documentation": "The list of groups the user is a member of.
" + "smithy.api#documentation": "The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "RefreshSchedules": { + "target": "com.amazonaws.quicksight#TopicRefreshScheduleSummaries", "traits": { - "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + "smithy.api#documentation": "The list of topic refresh schedules.
" } }, "Status": { @@ -24554,19 +26698,25 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } } }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.quicksight#ListUsers": { + "com.amazonaws.quicksight#ListTopics": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#ListUsersRequest" + "target": "com.amazonaws.quicksight#ListTopicsRequest" }, "output": { - "target": "com.amazonaws.quicksight#ListUsersResponse" + "target": "com.amazonaws.quicksight#ListTopicsResponse" }, "errors": [ { @@ -24581,35 +26731,31 @@ { "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, { "target": "com.amazonaws.quicksight#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "Returns a list of all of the Amazon QuickSight users belonging to this account.
", + "smithy.api#documentation": "Lists all of the topics within an account.
", "smithy.api#http": { "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users", + "uri": "/accounts/{AwsAccountId}/topics", "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" } } }, - "com.amazonaws.quicksight#ListUsersRequest": { + "com.amazonaws.quicksight#ListTopicsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the topics that you want to\n list.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -24617,7 +26763,7 @@ "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
", + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", "smithy.api#httpQuery": "next-token" } }, @@ -24625,36 +26771,372 @@ "target": "com.amazonaws.quicksight#MaxResults", "traits": { "smithy.api#default": null, - "smithy.api#documentation": "The maximum number of results to return from this request.
", + "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-results" } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "The namespace. Currently, you should set this to default.
The list of users.
" + "smithy.api#documentation": "A list of topic summaries.
" } }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListUserGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListUserGroupsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListUserGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListUserGroupsRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "The Amazon QuickSight user name that you want to list group memberships for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account\n\t\t\tthat contains your Amazon QuickSight account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace. Currently, you should set this to default.
A pagination token that can be used in a subsequent request.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of results to return from this request.
", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListUserGroupsResponse": { + "type": "structure", + "members": { + "GroupList": { + "target": "com.amazonaws.quicksight#GroupList", + "traits": { + "smithy.api#documentation": "The list of groups the user is a member of.
" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListUsersRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of all of the Amazon QuickSight users belonging to this account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListUsersRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of results to return from this request.
", + "smithy.api#httpQuery": "max-results" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace. Currently, you should set this to default.
The list of users.
" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListVPCConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListVPCConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListVPCConnectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all of the VPC connections in the current set Amazon Web Services Region of an\n\t\t\t\tAmazon Web Services account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/vpc-connections", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListVPCConnectionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the account that contains the VPC connections\n\t\t\tthat you want to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of results to be returned per request.
", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListVPCConnectionsResponse": { + "type": "structure", + "members": { + "VPCConnectionSummaries": { + "target": "com.amazonaws.quicksight#VPCConnectionSummaryList", + "traits": { + "smithy.api#documentation": "A VPCConnectionSummaries object that returns a summary of VPC connection\n\t\t\tobjects.
The token for the next set of results, or null if there are no more\n\t\t\tresults.
" } }, "RequestId": { @@ -24745,6 +27227,7 @@ "com.amazonaws.quicksight#LogicalTableId": { "type": "string", "traits": { + "smithy.api#documentation": "An identifier for the logical table that is defined in the dataset
", "smithy.api#length": { "min": 1, "max": 64 @@ -24938,6 +27421,41 @@ } } }, + "com.amazonaws.quicksight#MappedDataSetParameter": { + "type": "structure", + "members": { + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "A unique name that identifies a dataset within the analysis or dashboard.
", + "smithy.api#required": {} + } + }, + "DataSetParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "The name of the dataset parameter.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A dataset parameter that is mapped to an analysis parameter.
" + } + }, + "com.amazonaws.quicksight#MappedDataSetParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MappedDataSetParameter" + }, + "traits": { + "smithy.api#documentation": "A list of dataset parameters that are mapped to an analysis parameter.
", + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, "com.amazonaws.quicksight#MarginStyle": { "type": "structure", "members": { @@ -25287,177 +27805,607 @@ "smithy.api#documentation": "The parameters for MySQL.
" } }, - "com.amazonaws.quicksight#Namespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._-]*$" - } - }, - "com.amazonaws.quicksight#NamespaceError": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#NamespaceErrorType", - "traits": { - "smithy.api#documentation": "The error type.
" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The message for the error.
" - } - } - }, - "traits": { - "smithy.api#documentation": "Errors that occur during namespace creation.
" - } - }, - "com.amazonaws.quicksight#NamespaceErrorType": { + "com.amazonaws.quicksight#NamedEntityAggType": { "type": "enum", "members": { - "PERMISSION_DENIED": { + "SUM": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PERMISSION_DENIED" + "smithy.api#enumValue": "SUM" } }, - "INTERNAL_SERVICE_ERROR": { + "MIN": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" + "smithy.api#enumValue": "MIN" } - } - } - }, - "com.amazonaws.quicksight#NamespaceInfoV2": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#Namespace", + }, + "MAX": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of the error.
" + "smithy.api#enumValue": "MAX" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "COUNT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The namespace ARN.
" + "smithy.api#enumValue": "COUNT" } }, - "CapacityRegion": { - "target": "com.amazonaws.quicksight#String", + "AVERAGE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The namespace Amazon Web Services Region.
" + "smithy.api#enumValue": "AVERAGE" } }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#NamespaceStatus", + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The creation status of a namespace that is not yet completely created.
" + "smithy.api#enumValue": "DISTINCT_COUNT" } }, - "IdentityStore": { - "target": "com.amazonaws.quicksight#IdentityStore", + "STDEV": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The identity store used for the namespace.
" + "smithy.api#enumValue": "STDEV" } }, - "NamespaceError": { - "target": "com.amazonaws.quicksight#NamespaceError", + "STDEVP": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "An error that occurred when the namespace was created.
" + "smithy.api#enumValue": "STDEVP" } - } - }, - "traits": { - "smithy.api#documentation": "The error type.
" - } - }, - "com.amazonaws.quicksight#NamespaceStatus": { - "type": "enum", - "members": { - "CREATED": { + }, + "VAR": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CREATED" + "smithy.api#enumValue": "VAR" } }, - "CREATING": { + "VARP": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "CREATING" + "smithy.api#enumValue": "VARP" } }, - "DELETING": { + "PERCENTILE": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "DELETING" + "smithy.api#enumValue": "PERCENTILE" } }, - "RETRYABLE_FAILURE": { + "MEDIAN": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "RETRYABLE_FAILURE" + "smithy.api#enumValue": "MEDIAN" } }, - "NON_RETRYABLE_FAILURE": { + "CUSTOM": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NON_RETRYABLE_FAILURE" + "smithy.api#enumValue": "CUSTOM" } } } }, - "com.amazonaws.quicksight#Namespaces": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#NamespaceInfoV2" - } - }, - "com.amazonaws.quicksight#NarrativeString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 150000 - } - } - }, - "com.amazonaws.quicksight#NegativeValueConfiguration": { + "com.amazonaws.quicksight#NamedEntityDefinition": { "type": "structure", "members": { - "DisplayMode": { - "target": "com.amazonaws.quicksight#NegativeValueDisplayMode", + "FieldName": { + "target": "com.amazonaws.quicksight#LimitedString", "traits": { - "smithy.api#documentation": "Determines the display mode of the negative value configuration.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the entity.
" + } + }, + "PropertyName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The property name to be used for the named entity.
" + } + }, + "PropertyRole": { + "target": "com.amazonaws.quicksight#PropertyRole", + "traits": { + "smithy.api#documentation": "The property role. Valid values for this structure are PRIMARY and ID.
The property usage. Valid values for this structure are INHERIT,\n DIMENSION,\n and MEASURE.
The definition of a metric.
" } } }, "traits": { - "smithy.api#documentation": "The options that determine the negative value configuration.
" + "smithy.api#documentation": "A structure that represents a named entity.
" } }, - "com.amazonaws.quicksight#NegativeValueDisplayMode": { - "type": "enum", + "com.amazonaws.quicksight#NamedEntityDefinitionMetric": { + "type": "structure", "members": { - "POSITIVE": { - "target": "smithy.api#Unit", + "Aggregation": { + "target": "com.amazonaws.quicksight#NamedEntityAggType", "traits": { - "smithy.api#enumValue": "POSITIVE" + "smithy.api#documentation": "The aggregation of a named entity. Valid values for this structure are SUM,\n MIN, MAX, COUNT, AVERAGE,\n DISTINCT_COUNT, STDEV, STDEVP, VAR,\n VARP, PERCENTILE,\n MEDIAN,\n and CUSTOM.
The additional parameters for an aggregation function.
" } } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a metric.
" + } + }, + "com.amazonaws.quicksight#NamedEntityDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#NamedEntityDefinition" + } + }, + "com.amazonaws.quicksight#NamedFilterAggType": { + "type": "enum", + "members": { + "NO_AGGREGATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_AGGREGATION" + } + }, + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + } + } + }, + "com.amazonaws.quicksight#NamedFilterType": { + "type": "enum", + "members": { + "CATEGORY_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CATEGORY_FILTER" + } + }, + "NUMERIC_EQUALITY_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMERIC_EQUALITY_FILTER" + } + }, + "NUMERIC_RANGE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMERIC_RANGE_FILTER" + } + }, + "DATE_RANGE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE_RANGE_FILTER" + } + }, + "RELATIVE_DATE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELATIVE_DATE_FILTER" + } + } + } + }, + "com.amazonaws.quicksight#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]*$" + } + }, + "com.amazonaws.quicksight#NamespaceError": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#NamespaceErrorType", + "traits": { + "smithy.api#documentation": "The error type.
" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The message for the error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Errors that occur during namespace creation.
" + } + }, + "com.amazonaws.quicksight#NamespaceErrorType": { + "type": "enum", + "members": { + "PERMISSION_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERMISSION_DENIED" + } + }, + "INTERNAL_SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" + } + } + } + }, + "com.amazonaws.quicksight#NamespaceInfoV2": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The name of the error.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The namespace ARN.
" + } + }, + "CapacityRegion": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The namespace Amazon Web Services Region.
" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#NamespaceStatus", + "traits": { + "smithy.api#documentation": "The creation status of a namespace that is not yet completely created.
" + } + }, + "IdentityStore": { + "target": "com.amazonaws.quicksight#IdentityStore", + "traits": { + "smithy.api#documentation": "The identity store used for the namespace.
" + } + }, + "NamespaceError": { + "target": "com.amazonaws.quicksight#NamespaceError", + "traits": { + "smithy.api#documentation": "An error that occurred when the namespace was created.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The error type.
" + } + }, + "com.amazonaws.quicksight#NamespaceStatus": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "RETRYABLE_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRYABLE_FAILURE" + } + }, + "NON_RETRYABLE_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_RETRYABLE_FAILURE" + } + } + } + }, + "com.amazonaws.quicksight#Namespaces": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#NamespaceInfoV2" + } + }, + "com.amazonaws.quicksight#NarrativeString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150000 + } + } + }, + "com.amazonaws.quicksight#NegativeFormat": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The prefix for a negative format.
" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The suffix for a negative format.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a negative format.
" + } + }, + "com.amazonaws.quicksight#NegativeValueConfiguration": { + "type": "structure", + "members": { + "DisplayMode": { + "target": "com.amazonaws.quicksight#NegativeValueDisplayMode", + "traits": { + "smithy.api#documentation": "Determines the display mode of the negative value configuration.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The options that determine the negative value configuration.
" + } + }, + "com.amazonaws.quicksight#NegativeValueDisplayMode": { + "type": "enum", + "members": { + "POSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSITIVE" + } + }, + "NEGATIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEGATIVE" + } + } + } + }, + "com.amazonaws.quicksight#NetworkInterface": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.quicksight#SubnetId", + "traits": { + "smithy.api#documentation": "The subnet ID associated with the network interface.
" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The availability zone that the network interface resides in.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "An error message.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#NetworkInterfaceStatus", + "traits": { + "smithy.api#documentation": "The status of the network interface.
" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.quicksight#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "The network interface ID.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structure that contains information about a network interface.
" + } + }, + "com.amazonaws.quicksight#NetworkInterfaceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^eni-[0-9a-z]*$" + } + }, + "com.amazonaws.quicksight#NetworkInterfaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#NetworkInterface" + } + }, + "com.amazonaws.quicksight#NetworkInterfaceStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_FAILED" + } + }, + "DELETION_SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_SCHEDULED" + } + }, + "ATTACHMENT_FAILED_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT_FAILED_ROLLBACK_FAILED" + } + } + } + }, + "com.amazonaws.quicksight#NewDefaultValues": { + "type": "structure", + "members": { + "StringStaticValues": { + "target": "com.amazonaws.quicksight#StringDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "A list of static default values for a given string parameter.
" + } + }, + "DecimalStaticValues": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "A list of static default values for a given decimal parameter.
" + } + }, + "DateTimeStaticValues": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "A list of static default values for a given date time parameter.
" + } + }, + "IntegerStaticValues": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "A list of static default values for a given integer parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.
" } }, "com.amazonaws.quicksight#NonEmptyString": { @@ -26009,14 +28957,14 @@ "target": "com.amazonaws.quicksight#Port", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Port.
", + "smithy.api#documentation": "The port.
", "smithy.api#required": {} } }, "Database": { "target": "com.amazonaws.quicksight#Database", "traits": { - "smithy.api#documentation": "Database.
", + "smithy.api#documentation": "The database.
", "smithy.api#required": {} } } @@ -26060,7 +29008,7 @@ "Type": { "target": "com.amazonaws.quicksight#ColumnDataType", "traits": { - "smithy.api#documentation": "Type.
" + "smithy.api#documentation": "The type.
" } } }, @@ -26074,6 +29022,33 @@ "target": "com.amazonaws.quicksight#OutputColumn" } }, + "com.amazonaws.quicksight#OverrideDatasetParameterOperation": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "The name of the parameter to be overridden with different values.
", + "smithy.api#required": {} + } + }, + "NewParameterName": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "The new name for the parameter.
" + } + }, + "NewDefaultValues": { + "target": "com.amazonaws.quicksight#NewDefaultValues", + "traits": { + "smithy.api#documentation": "The new default values for the parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A transform operation that overrides the dataset parameter values that are defined in another dataset.
" + } + }, "com.amazonaws.quicksight#PageNumber": { "type": "long", "traits": { @@ -28138,6 +31113,46 @@ } } }, + "com.amazonaws.quicksight#PropertyRole": { + "type": "enum", + "members": { + "PRIMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY" + } + }, + "ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID" + } + } + } + }, + "com.amazonaws.quicksight#PropertyUsage": { + "type": "enum", + "members": { + "INHERIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INHERIT" + } + }, + "DIMENSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIMENSION" + } + }, + "MEASURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEASURE" + } + } + } + }, "com.amazonaws.quicksight#PutDataSetRefreshProperties": { "type": "operation", "input": { @@ -28345,6 +31360,15 @@ { "target": "com.amazonaws.quicksight#CreateThemeAlias" }, + { + "target": "com.amazonaws.quicksight#CreateTopic" + }, + { + "target": "com.amazonaws.quicksight#CreateTopicRefreshSchedule" + }, + { + "target": "com.amazonaws.quicksight#CreateVPCConnection" + }, { "target": "com.amazonaws.quicksight#DeleteAccountCustomization" }, @@ -28399,12 +31423,21 @@ { "target": "com.amazonaws.quicksight#DeleteThemeAlias" }, + { + "target": "com.amazonaws.quicksight#DeleteTopic" + }, + { + "target": "com.amazonaws.quicksight#DeleteTopicRefreshSchedule" + }, { "target": "com.amazonaws.quicksight#DeleteUser" }, { "target": "com.amazonaws.quicksight#DeleteUserByPrincipalId" }, + { + "target": "com.amazonaws.quicksight#DeleteVPCConnection" + }, { "target": "com.amazonaws.quicksight#DescribeAccountCustomization" }, @@ -28498,9 +31531,24 @@ { "target": "com.amazonaws.quicksight#DescribeThemePermissions" }, + { + "target": "com.amazonaws.quicksight#DescribeTopic" + }, + { + "target": "com.amazonaws.quicksight#DescribeTopicPermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeTopicRefresh" + }, + { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshSchedule" + }, { "target": "com.amazonaws.quicksight#DescribeUser" }, + { + "target": "com.amazonaws.quicksight#DescribeVPCConnection" + }, { "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUser" }, @@ -28576,12 +31624,21 @@ { "target": "com.amazonaws.quicksight#ListThemeVersions" }, + { + "target": "com.amazonaws.quicksight#ListTopicRefreshSchedules" + }, + { + "target": "com.amazonaws.quicksight#ListTopics" + }, { "target": "com.amazonaws.quicksight#ListUserGroups" }, { "target": "com.amazonaws.quicksight#ListUsers" }, + { + "target": "com.amazonaws.quicksight#ListVPCConnections" + }, { "target": "com.amazonaws.quicksight#PutDataSetRefreshProperties" }, @@ -28687,8 +31744,20 @@ { "target": "com.amazonaws.quicksight#UpdateThemePermissions" }, + { + "target": "com.amazonaws.quicksight#UpdateTopic" + }, + { + "target": "com.amazonaws.quicksight#UpdateTopicPermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateTopicRefreshSchedule" + }, { "target": "com.amazonaws.quicksight#UpdateUser" + }, + { + "target": "com.amazonaws.quicksight#UpdateVPCConnection" } ], "traits": { @@ -29865,6 +32934,26 @@ "smithy.api#documentation": "A radar chart visual.
" } }, + "com.amazonaws.quicksight#RangeConstant": { + "type": "structure", + "members": { + "Minimum": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The minimum value for a range constant.
" + } + }, + "Maximum": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The maximum value for a range constant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a range constant.
" + } + }, "com.amazonaws.quicksight#RangeEndsLabelType": { "type": "structure", "members": { @@ -30031,8 +33120,7 @@ "MeasureAggregationFunction": { "target": "com.amazonaws.quicksight#AggregationFunction", "traits": { - "smithy.api#documentation": "The aggregation function that is used in the dynamic data.
", - "smithy.api#required": {} + "smithy.api#documentation": "The aggregation function that is used in the dynamic data.
" } }, "Calculation": { @@ -30588,6 +33676,12 @@ "traits": { "smithy.api#documentation": "The state persistence settings of an embedded dashboard.
" } + }, + "Bookmarks": { + "target": "com.amazonaws.quicksight#BookmarksConfigurations", + "traits": { + "smithy.api#documentation": "The bookmarks configuration for an embedded dashboard in Amazon QuickSight.
" + } } }, "traits": { @@ -31767,6 +34861,12 @@ "traits": { "smithy.api#documentation": "The size field well of a scatter plot.
" } + }, + "Label": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "The label field well of a scatter plot.
" + } } }, "traits": { @@ -31841,13 +34941,13 @@ "ScatterPlotCategoricallyAggregatedFieldWells": { "target": "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells", "traits": { - "smithy.api#documentation": "The aggregated field wells of a scatter plot. Scatter plots that have a field in the category (group/color) field will have aggregated field wells. The x and y-axes of these scatter plots are aggregated by category.
" + "smithy.api#documentation": "The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.
" } }, "ScatterPlotUnaggregatedFieldWells": { "target": "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells", "traits": { - "smithy.api#documentation": "The unaggregated field wells of a scatter plot. Scatter plots without a category field\n well have unaggregated field wells. The x and y-axes of these scatter plots are\n unaggregated.
" + "smithy.api#documentation": "The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are\n unaggregated.
" } } }, @@ -31875,6 +34975,18 @@ "traits": { "smithy.api#documentation": "The size field well of a scatter plot.
" } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "The category field well of a scatter plot.
" + } + }, + "Label": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "The label field well of a scatter plot.
" + } } }, "traits": { @@ -32843,6 +35955,28 @@ "smithy.api#documentation": "The options that style a section.
" } }, + "com.amazonaws.quicksight#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^sg-[0-9a-z]*$" + } + }, + "com.amazonaws.quicksight#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, "com.amazonaws.quicksight#SelectAllValueOptions": { "type": "enum", "members": { @@ -32908,6 +36042,82 @@ } } }, + "com.amazonaws.quicksight#SemanticEntityType": { + "type": "structure", + "members": { + "TypeName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The semantic entity type name.
" + } + }, + "SubTypeName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The semantic entity sub type name.
" + } + }, + "TypeParameters": { + "target": "com.amazonaws.quicksight#TypeParameters", + "traits": { + "smithy.api#documentation": "The semantic entity type parameters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a semantic entity type.
" + } + }, + "com.amazonaws.quicksight#SemanticType": { + "type": "structure", + "members": { + "TypeName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The semantic type name.
" + } + }, + "SubTypeName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The semantic type sub type name.
" + } + }, + "TypeParameters": { + "target": "com.amazonaws.quicksight#TypeParameters", + "traits": { + "smithy.api#documentation": "The semantic type parameters.
" + } + }, + "TruthyCellValue": { + "target": "com.amazonaws.quicksight#SensitiveString", + "traits": { + "smithy.api#documentation": "The semantic type truthy cell value.
" + } + }, + "TruthyCellValueSynonyms": { + "target": "com.amazonaws.quicksight#SensitiveStringList", + "traits": { + "smithy.api#documentation": "The other names or aliases for the true cell value.
" + } + }, + "FalseyCellValue": { + "target": "com.amazonaws.quicksight#SensitiveString", + "traits": { + "smithy.api#documentation": "The semantic type falsey cell value.
" + } + }, + "FalseyCellValueSynonyms": { + "target": "com.amazonaws.quicksight#SensitiveStringList", + "traits": { + "smithy.api#documentation": "The other names or aliases for the false cell value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a semantic type.
" + } + }, "com.amazonaws.quicksight#SensitiveDouble": { "type": "double", "traits": { @@ -34027,6 +37237,77 @@ "com.amazonaws.quicksight#String": { "type": "string" }, + "com.amazonaws.quicksight#StringDatasetParameter": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.quicksight#DatasetParameterId", + "traits": { + "smithy.api#documentation": "An identifier for the string parameter that is created in the dataset.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "The name of the string parameter that is created in the dataset.
", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.quicksight#DatasetParameterValueType", + "traits": { + "smithy.api#documentation": "The value type of the dataset parameter. Valid values are single value or multi value.
A list of default values for a given string dataset parameter type. This structure only accepts static values.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A string parameter for a dataset.
" + } + }, + "com.amazonaws.quicksight#StringDatasetParameterDefaultValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "The default value for the string parameter.
", + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#StringDatasetParameterDefaultValues": { + "type": "structure", + "members": { + "StaticValues": { + "target": "com.amazonaws.quicksight#StringDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "A list of static default values for a given string parameter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The default values of a string parameter.
" + } + }, + "com.amazonaws.quicksight#StringDatasetParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#StringDatasetParameterDefaultValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, "com.amazonaws.quicksight#StringDefaultValueList": { "type": "list", "member": { @@ -34135,6 +37416,9 @@ "traits": { "smithy.api#documentation": "The configuration that defines the default value of a String parameter when a value has not been set.
The configuration that defines the default value of a String parameter when a value has not been set.
Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
\nTags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the TagResource operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, and template.
\nTagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:
\nYou can't use tags to track costs for Amazon QuickSight. This isn't\n\t\t\t\tpossible because you can't tag the resources that Amazon QuickSight costs are based \n\t\t\t\ton, for example Amazon QuickSight storage capacity (SPICE), number of users, type \n\t\t\t\tof users, and usage metrics.
\nAmazon QuickSight doesn't currently support the tag editor for Resource Groups.
\nAssigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.
\nTags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the TagResource operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.
You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, template, and topic.
\nTagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:
\nYou can't use tags to track costs for Amazon QuickSight. This isn't\n\t\t\t\tpossible because you can't tag the resources that Amazon QuickSight costs are based \n\t\t\t\ton, for example Amazon QuickSight storage capacity (SPICE), number of users, type \n\t\t\t\tof users, and usage metrics.
\nAmazon QuickSight doesn't currently support the tag editor for Resource Groups.
\nThe prediction interval setup of a forecast computation.
" } }, - "Seasonality": { - "target": "com.amazonaws.quicksight#Seasonality", + "Seasonality": { + "target": "com.amazonaws.quicksight#Seasonality", + "traits": { + "smithy.api#documentation": "The seasonality setup of a forecast computation. Choose one of the following options:
\n\n NULL: The input is set to NULL.
\n NON_NULL: The input is set to a custom value.
The forecast properties setup of a forecast in the line chart.
" + } + }, + "com.amazonaws.quicksight#TimeEqualityFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "The column that the filter is applied to.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The value of a TimeEquality filter.
This field is mutually exclusive to ParameterName.
The parameter whose value should be used for the filter value.
\nThis field is mutually exclusive to Value.
The level of time precision that is used to aggregate DateTime values.
A TimeEqualityFilter filters values that are equal to a given value.
The column that the filter is applied to.
", + "smithy.api#required": {} + } + }, + "RangeMinimum": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The minimum value for the filter value range.
", + "smithy.api#required": {} + } + }, + "RangeMaximum": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The maximum value for the filter value range.
", + "smithy.api#required": {} + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "The level of time precision that is used to aggregate DateTime values.
The time range drill down filter.
" + } + }, + "com.amazonaws.quicksight#TimeRangeFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "The column that the filter is applied to.
", + "smithy.api#required": {} + } + }, + "IncludeMinimum": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Determines whether the minimum value in the filter value range should be included in the filtered results.
" + } + }, + "IncludeMaximum": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Determines whether the maximum value in the filter value range should be included in the filtered results.
" + } + }, + "RangeMinimumValue": { + "target": "com.amazonaws.quicksight#TimeRangeFilterValue", + "traits": { + "smithy.api#documentation": "The minimum value for the filter value range.
" + } + }, + "RangeMaximumValue": { + "target": "com.amazonaws.quicksight#TimeRangeFilterValue", + "traits": { + "smithy.api#documentation": "The maximum value for the filter value range.
" + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "This option determines how null values should be treated when filtering data.
\n\n ALL_VALUES: Include null values in filtered results.
\n NULLS_ONLY: Only include null values in filtered results.
\n NON_NULLS_ONLY: Exclude null values from filtered results.
The exclude period of the time range filter.
" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "The level of time precision that is used to aggregate DateTime values.
A TimeRangeFilter filters values that are between two specified values.
The static input value.
" + } + }, + "RollingDate": { + "target": "com.amazonaws.quicksight#RollingDateConfiguration", + "traits": { + "smithy.api#documentation": "The rolling date input value.
" + } + }, + "Parameter": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "The parameter type input value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The value of a time range filter.
\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" + } + }, + "com.amazonaws.quicksight#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.quicksight#TooltipItem": { + "type": "structure", + "members": { + "FieldTooltipItem": { + "target": "com.amazonaws.quicksight#FieldTooltipItem", + "traits": { + "smithy.api#documentation": "The tooltip item for the fields.
" + } + }, + "ColumnTooltipItem": { + "target": "com.amazonaws.quicksight#ColumnTooltipItem", + "traits": { + "smithy.api#documentation": "The tooltip item for the columns that are not part of a field well.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The tooltip.
\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" + } + }, + "com.amazonaws.quicksight#TooltipItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TooltipItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#TooltipOptions": { + "type": "structure", + "members": { + "TooltipVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "Determines whether or not the tooltip is visible.
" + } + }, + "SelectedTooltipType": { + "target": "com.amazonaws.quicksight#SelectedTooltipType", + "traits": { + "smithy.api#documentation": "The selected type for the tooltip. Choose one of the following options:
\n\n BASIC: A basic tooltip.
\n DETAILED: A detailed tooltip.
The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The display options for the visual tooltip.
" + } + }, + "com.amazonaws.quicksight#TooltipTitleType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "PRIMARY_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY_VALUE" + } + } + } + }, + "com.amazonaws.quicksight#TopBottomComputationType": { + "type": "enum", + "members": { + "TOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP" + } + }, + "BOTTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTOM" + } + } + } + }, + "com.amazonaws.quicksight#TopBottomFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "The column that the filter is applied to.
", + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The number of items to include in the top bottom filter results.
" + } + }, + "AggregationSortConfigurations": { + "target": "com.amazonaws.quicksight#AggregationSortConfigurationList", + "traits": { + "smithy.api#documentation": "The aggregation and sort configuration of the top bottom filter.
", + "smithy.api#required": {} + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "The level of time precision that is used to aggregate DateTime values.
The parameter whose value should be used for the filter value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A TopBottomFilter filters values that are at the top or the bottom.
The ID for a computation.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The name of a computation.
" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "The time field that is used in a computation.
", + "smithy.api#required": {} + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "The category field that is used in a computation.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "The value field that is used in a computation.
" + } + }, + "MoverSize": { + "target": "com.amazonaws.quicksight#TopBottomMoversComputationMoverSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The mover size setup of the top and bottom movers computation.
" + } + }, + "SortOrder": { + "target": "com.amazonaws.quicksight#TopBottomSortOrder", + "traits": { + "smithy.api#documentation": "The sort order setup of the top and bottom movers computation.
" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#TopBottomComputationType", + "traits": { + "smithy.api#documentation": "The computation type. Choose from the following options:
\nTOP: Top movers computation.
\nBOTTOM: Bottom movers computation.
\nThe top movers and bottom movers computation setup.
" + } + }, + "com.amazonaws.quicksight#TopBottomMoversComputationMoverSize": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#TopBottomRankedComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID for a computation.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The name of a computation.
" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "The category field that is used in a computation.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "The value field that is used in a computation.
" + } + }, + "ResultSize": { + "target": "com.amazonaws.quicksight#TopBottomRankedComputationResultSize", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The result size of a top and bottom ranked computation.
" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#TopBottomComputationType", + "traits": { + "smithy.api#documentation": "The computation type. Choose one of the following options:
\nTOP: A top ranked computation.
\nBOTTOM: A bottom ranked computation.
\nThe top ranked and bottom ranked computation configuration.
" + } + }, + "com.amazonaws.quicksight#TopBottomRankedComputationResultSize": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#TopBottomSortOrder": { + "type": "enum", + "members": { + "PERCENT_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT_DIFFERENCE" + } + }, + "ABSOLUTE_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSOLUTE_DIFFERENCE" + } + } + } + }, + "com.amazonaws.quicksight#TopicCalculatedField": { + "type": "structure", + "members": { + "CalculatedFieldName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The calculated field name.
", + "smithy.api#required": {} + } + }, + "CalculatedFieldDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The calculated field description.
" + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "The calculated field expression.
", + "smithy.api#required": {} + } + }, + "CalculatedFieldSynonyms": { + "target": "com.amazonaws.quicksight#Synonyms", + "traits": { + "smithy.api#documentation": "The other names or aliases for the calculated field.
" + } + }, + "IsIncludedInTopic": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A boolean value that indicates if a calculated field is included in the topic.
" + } + }, + "DisableIndexing": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "A Boolean value that indicates if a calculated field is visible in the autocomplete.
" + } + }, + "ColumnDataRole": { + "target": "com.amazonaws.quicksight#ColumnDataRole", + "traits": { + "smithy.api#documentation": "The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
The level of time precision that is used to aggregate DateTime values.
The default formatting definition.
" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#DefaultAggregation", + "traits": { + "smithy.api#documentation": "The default aggregation. Valid values for this structure are SUM,\n MAX, MIN, COUNT,\n DISTINCT_COUNT,\n and AVERAGE.
The order in which data is displayed for the calculated field when\n it's used in a comparative context.
" + } + }, + "SemanticType": { + "target": "com.amazonaws.quicksight#SemanticType", + "traits": { + "smithy.api#documentation": "The semantic type.
" + } + }, + "AllowedAggregations": { + "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", + "traits": { + "smithy.api#documentation": "The list of aggregation types that are allowed for the calculated field. Valid values\n for this structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP, and PERCENTILE.
The list of aggregation types that are not allowed for the calculated field. Valid\n values for this structure are COUNT, DISTINCT_COUNT,\n MIN, MAX, MEDIAN, SUM,\n AVERAGE, STDEV, STDEVP, VAR,\n VARP, and PERCENTILE.
A Boolean value that indicates whether to never aggregate calculated field in filters.
" + } + }, + "CellValueSynonyms": { + "target": "com.amazonaws.quicksight#CellValueSynonyms", + "traits": { + "smithy.api#documentation": "The other\n names or aliases for the calculated field cell value.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a calculated field.
" + } + }, + "com.amazonaws.quicksight#TopicCalculatedFields": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicCalculatedField" + } + }, + "com.amazonaws.quicksight#TopicCategoryFilter": { + "type": "structure", + "members": { + "CategoryFilterFunction": { + "target": "com.amazonaws.quicksight#CategoryFilterFunction", + "traits": { + "smithy.api#documentation": "The category filter function. Valid values for this structure are EXACT and CONTAINS.
The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.
" + } + }, + "Constant": { + "target": "com.amazonaws.quicksight#TopicCategoryFilterConstant", + "traits": { + "smithy.api#documentation": "The constant used in a category filter.
" + } + }, + "Inverse": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean value that indicates if the filter is inverse.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a category filter.
" + } + }, + "com.amazonaws.quicksight#TopicCategoryFilterConstant": { + "type": "structure", + "members": { + "ConstantType": { + "target": "com.amazonaws.quicksight#ConstantType", + "traits": { + "smithy.api#documentation": "The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE.
A singular constant used in a category filter. This element is used to specify a single value for the constant.
" + } + }, + "CollectiveConstant": { + "target": "com.amazonaws.quicksight#CollectiveConstant", + "traits": { + "smithy.api#documentation": "A collective constant used in a category filter. This element is used to specify a list of values for the constant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A constant used in a category filter.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#TopicColumn": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The name of the column.
", + "smithy.api#required": {} + } + }, + "ColumnFriendlyName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "A user-friendly name for the column.
" + } + }, + "ColumnDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "A description of the column and its contents.
" + } + }, + "ColumnSynonyms": { + "target": "com.amazonaws.quicksight#Synonyms", + "traits": { + "smithy.api#documentation": "The other names or aliases for the column.
" + } + }, + "ColumnDataRole": { + "target": "com.amazonaws.quicksight#ColumnDataRole", + "traits": { + "smithy.api#documentation": "The role of the column in the data. Valid values are DIMENSION and MEASURE.
The type of aggregation that is performed on the column data when\n it's queried. Valid values for this structure are SUM, MAX,\n MIN, COUNT,\n DISTINCT_COUNT, and AVERAGE.
A Boolean value that indicates whether the column is included in the query results.
" + } + }, + "DisableIndexing": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "A Boolean value that indicates whether the column shows in the autocomplete functionality.
" + } + }, + "ComparativeOrder": { + "target": "com.amazonaws.quicksight#ComparativeOrder", + "traits": { + "smithy.api#documentation": "The order in which data is displayed for the column when\n it's used in a comparative context.
" + } + }, + "SemanticType": { + "target": "com.amazonaws.quicksight#SemanticType", + "traits": { + "smithy.api#documentation": "The semantic type of data contained in the column.
" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "The level of time precision that is used to aggregate DateTime values.
The list of aggregation types that are allowed for the column. Valid values for this\n structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP,\n and PERCENTILE.
The list of aggregation types that are not allowed for the column. Valid values for this\n structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP,\n and PERCENTILE.
The default formatting used for values in the column.
" + } + }, + "NeverAggregateInFilter": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean\n value that indicates whether to aggregate the column data when\n it's used in a filter context.
" + } + }, + "CellValueSynonyms": { + "target": "com.amazonaws.quicksight#CellValueSynonyms", "traits": { - "smithy.api#documentation": "The seasonality setup of a forecast computation. Choose one of the following options:
\n\n NULL: The input is set to NULL.
\n NON_NULL: The input is set to a custom value.
The other names or aliases for the column cell value.
" } } }, "traits": { - "smithy.api#documentation": "The forecast properties setup of a forecast in the line chart.
" + "smithy.api#documentation": "Represents a column in a dataset.
" } }, - "com.amazonaws.quicksight#TimeEqualityFilter": { + "com.amazonaws.quicksight#TopicColumns": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicColumn" + } + }, + "com.amazonaws.quicksight#TopicDateRangeFilter": { "type": "structure", "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "Inclusive": { + "target": "com.amazonaws.quicksight#Boolean", "traits": { - "smithy.api#documentation": "An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
", - "smithy.api#required": {} + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean value that indicates whether the date range filter should include the boundary values. If\n set to true, the filter includes the start and end dates. If set to false, the filter\n excludes them.
" } }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", + "Constant": { + "target": "com.amazonaws.quicksight#TopicRangeFilterConstant", "traits": { - "smithy.api#documentation": "The column that the filter is applied to.
", - "smithy.api#required": {} + "smithy.api#documentation": "The constant used in a date range filter.
" } - }, - "Value": { - "target": "com.amazonaws.quicksight#Timestamp", + } + }, + "traits": { + "smithy.api#documentation": "A filter used to restrict data based on a range of dates or times.
" + } + }, + "com.amazonaws.quicksight#TopicDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", "traits": { - "smithy.api#documentation": "The value of a TimeEquality filter.
This field is mutually exclusive to ParameterName.
The name of the topic.
" } }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", + "Description": { + "target": "com.amazonaws.quicksight#LimitedString", "traits": { - "smithy.api#documentation": "The parameter whose value should be used for the filter value.
\nThis field is mutually exclusive to Value.
The description of the topic.
" } }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", + "DataSets": { + "target": "com.amazonaws.quicksight#Datasets", "traits": { - "smithy.api#documentation": "The level of time precision that is used to aggregate DateTime values.
The data sets that the topic is associated with.
" } } }, "traits": { - "smithy.api#documentation": "A TimeEqualityFilter filters values that are equal to a given value.
A structure that describes the details of a topic, such as its name, description, and associated data sets.
" } }, - "com.amazonaws.quicksight#TimeGranularity": { - "type": "enum", + "com.amazonaws.quicksight#TopicFilter": { + "type": "structure", "members": { - "YEAR": { - "target": "smithy.api#Unit", + "FilterDescription": { + "target": "com.amazonaws.quicksight#LimitedString", "traits": { - "smithy.api#enumValue": "YEAR" + "smithy.api#documentation": "A description of the filter used to select items for a topic.
" } }, - "QUARTER": { - "target": "smithy.api#Unit", + "FilterClass": { + "target": "com.amazonaws.quicksight#FilterClass", "traits": { - "smithy.api#enumValue": "QUARTER" + "smithy.api#documentation": "The class of the filter. Valid values for this structure are\n ENFORCED_VALUE_FILTER,\n CONDITIONAL_VALUE_FILTER,\n and NAMED_VALUE_FILTER.
The name of the filter.
", + "smithy.api#required": {} } }, - "WEEK": { - "target": "smithy.api#Unit", + "FilterSynonyms": { + "target": "com.amazonaws.quicksight#Synonyms", "traits": { - "smithy.api#enumValue": "WEEK" + "smithy.api#documentation": "The other names or aliases for the filter.
" } }, - "DAY": { - "target": "smithy.api#Unit", + "OperandFieldName": { + "target": "com.amazonaws.quicksight#LimitedString", "traits": { - "smithy.api#enumValue": "DAY" + "smithy.api#documentation": "The name of the field that the filter operates on.
", + "smithy.api#required": {} } }, - "HOUR": { - "target": "smithy.api#Unit", + "FilterType": { + "target": "com.amazonaws.quicksight#NamedFilterType", "traits": { - "smithy.api#enumValue": "HOUR" + "smithy.api#documentation": "The type of the filter. Valid values for this structure are\n CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER,\n NUMERIC_RANGE_FILTER,\n DATE_RANGE_FILTER,\n and RELATIVE_DATE_FILTER.
The category filter that is associated with this filter.
" } }, - "SECOND": { - "target": "smithy.api#Unit", + "NumericEqualityFilter": { + "target": "com.amazonaws.quicksight#TopicNumericEqualityFilter", "traits": { - "smithy.api#enumValue": "SECOND" + "smithy.api#documentation": "The numeric equality filter.
" } }, - "MILLISECOND": { - "target": "smithy.api#Unit", + "NumericRangeFilter": { + "target": "com.amazonaws.quicksight#TopicNumericRangeFilter", "traits": { - "smithy.api#enumValue": "MILLISECOND" + "smithy.api#documentation": "The numeric range filter.
" + } + }, + "DateRangeFilter": { + "target": "com.amazonaws.quicksight#TopicDateRangeFilter", + "traits": { + "smithy.api#documentation": "The date range filter.
" + } + }, + "RelativeDateFilter": { + "target": "com.amazonaws.quicksight#TopicRelativeDateFilter", + "traits": { + "smithy.api#documentation": "The relative date filter.
" } } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a filter used to select items for a topic.
" } }, - "com.amazonaws.quicksight#TimeRangeDrillDownFilter": { + "com.amazonaws.quicksight#TopicFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicFilter" + } + }, + "com.amazonaws.quicksight#TopicId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.\\\\+]*$" + } + }, + "com.amazonaws.quicksight#TopicNamedEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicNamedEntity" + } + }, + "com.amazonaws.quicksight#TopicNamedEntity": { "type": "structure", "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", + "EntityName": { + "target": "com.amazonaws.quicksight#LimitedString", "traits": { - "smithy.api#documentation": "The column that the filter is applied to.
", + "smithy.api#documentation": "The name of the named entity.
", "smithy.api#required": {} } }, - "RangeMinimum": { - "target": "com.amazonaws.quicksight#Timestamp", + "EntityDescription": { + "target": "com.amazonaws.quicksight#LimitedString", "traits": { - "smithy.api#documentation": "The minimum value for the filter value range.
", - "smithy.api#required": {} + "smithy.api#documentation": "The description of the named entity.
" } }, - "RangeMaximum": { - "target": "com.amazonaws.quicksight#Timestamp", + "EntitySynonyms": { + "target": "com.amazonaws.quicksight#Synonyms", "traits": { - "smithy.api#documentation": "The maximum value for the filter value range.
", - "smithy.api#required": {} + "smithy.api#documentation": "The other\n names or aliases for the named entity.
" } }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", + "SemanticEntityType": { + "target": "com.amazonaws.quicksight#SemanticEntityType", "traits": { - "smithy.api#documentation": "The level of time precision that is used to aggregate DateTime values.
The type of named entity that a topic represents.
" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#NamedEntityDefinitions", + "traits": { + "smithy.api#documentation": "The definition of a named entity.
" } } }, "traits": { - "smithy.api#documentation": "The time range drill down filter.
" + "smithy.api#documentation": "A structure that represents a named entity.
" } }, - "com.amazonaws.quicksight#TimeRangeFilter": { + "com.amazonaws.quicksight#TopicNumericEqualityFilter": { "type": "structure", "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "Constant": { + "target": "com.amazonaws.quicksight#TopicSingularFilterConstant", "traits": { - "smithy.api#documentation": "An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
", - "smithy.api#required": {} + "smithy.api#documentation": "The constant used in a numeric equality filter.
" } }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", + "Aggregation": { + "target": "com.amazonaws.quicksight#NamedFilterAggType", "traits": { - "smithy.api#documentation": "The column that the filter is applied to.
", - "smithy.api#required": {} + "smithy.api#documentation": "An aggregation function that specifies how to calculate the value of a numeric field for\n a topic. Valid values for this structure are NO_AGGREGATION, SUM,\n AVERAGE, COUNT, DISTINCT_COUNT, MAX,\n MEDIAN, MIN, STDEV, STDEVP,\n VAR,\n and VARP.
A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.
" + } + }, + "com.amazonaws.quicksight#TopicNumericRangeFilter": { + "type": "structure", + "members": { + "Inclusive": { "target": "com.amazonaws.quicksight#Boolean", "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "Determines whether the minimum value in the filter value range should be included in the filtered results.
" + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.\n If set to true, topics whose numeric field value is equal to the endpoint values will be\n included in the filter. If set to false, topics whose numeric field value is equal to the\n endpoint values will be excluded from the filter.
" } }, - "IncludeMaximum": { - "target": "com.amazonaws.quicksight#Boolean", + "Constant": { + "target": "com.amazonaws.quicksight#TopicRangeFilterConstant", "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "Determines whether the maximum value in the filter value range should be included in the filtered results.
" + "smithy.api#documentation": "The constant used in a\n numeric range filter.
" } }, - "RangeMinimumValue": { - "target": "com.amazonaws.quicksight#TimeRangeFilterValue", + "Aggregation": { + "target": "com.amazonaws.quicksight#NamedFilterAggType", "traits": { - "smithy.api#documentation": "The minimum value for the filter value range.
" + "smithy.api#documentation": "An aggregation function that specifies how to calculate the value of a numeric field for\n a topic, Valid values for this structure are NO_AGGREGATION, SUM,\n AVERAGE, COUNT, DISTINCT_COUNT, MAX,\n MEDIAN, MIN, STDEV, STDEVP,\n VAR,\n and VARP.
A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.
" + } + }, + "com.amazonaws.quicksight#TopicNumericSeparatorSymbol": { + "type": "enum", + "members": { + "COMMA": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The maximum value for the filter value range.
" + "smithy.api#enumValue": "COMMA" } }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", + "DOT": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "This option determines how null values should be treated when filtering data.
\n\n ALL_VALUES: Include null values in filtered results.
\n NULLS_ONLY: Only include null values in filtered results.
\n NON_NULLS_ONLY: Exclude null values from filtered results.
The exclude period of the time range filter.
" + "smithy.api#documentation": "The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.
The level of time precision that is used to aggregate DateTime values.
The value of the constant that is used to specify the endpoints of a range filter.
" } } }, "traits": { - "smithy.api#documentation": "A TimeRangeFilter filters values that are between two specified values.
A constant value that is used in a range filter to specify the endpoints of the range.
", + "smithy.api#sensitive": {} } }, - "com.amazonaws.quicksight#TimeRangeFilterValue": { + "com.amazonaws.quicksight#TopicRefreshDetails": { "type": "structure", "members": { - "StaticValue": { - "target": "com.amazonaws.quicksight#Timestamp", + "RefreshArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The static input value.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic refresh.
" } }, - "RollingDate": { - "target": "com.amazonaws.quicksight#RollingDateConfiguration", + "RefreshId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The rolling date input value.
" + "smithy.api#documentation": "The ID of the refresh, which occurs as a result of topic creation or topic update.
" } }, - "Parameter": { - "target": "com.amazonaws.quicksight#ParameterName", + "RefreshStatus": { + "target": "com.amazonaws.quicksight#TopicRefreshStatus", "traits": { - "smithy.api#documentation": "The parameter type input value.
" + "smithy.api#documentation": "The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.
" } } }, "traits": { - "smithy.api#documentation": "The value of a time range filter.
\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" + "smithy.api#documentation": "The details about the refresh of a topic.
" } }, - "com.amazonaws.quicksight#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.quicksight#TooltipItem": { + "com.amazonaws.quicksight#TopicRefreshSchedule": { "type": "structure", "members": { - "FieldTooltipItem": { - "target": "com.amazonaws.quicksight#FieldTooltipItem", + "IsEnabled": { + "target": "com.amazonaws.quicksight#NullableBoolean", "traits": { - "smithy.api#documentation": "The tooltip item for the fields.
" + "smithy.api#documentation": "A Boolean value that controls whether to schedule is enabled.
", + "smithy.api#required": {} } }, - "ColumnTooltipItem": { - "target": "com.amazonaws.quicksight#ColumnTooltipItem", + "BasedOnSpiceSchedule": { + "target": "com.amazonaws.quicksight#Boolean", "traits": { - "smithy.api#documentation": "The tooltip item for the columns that are not part of a field well.
" + "smithy.api#default": false, + "smithy.api#documentation": "A Boolean value that controls whether to schedule runs at the same schedule that is specified in\n SPICE dataset.
", + "smithy.api#required": {} + } + }, + "StartingAt": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The starting date and time for the refresh schedule.
" + } + }, + "Timezone": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The timezone that you want the refresh schedule to use.
" + } + }, + "RepeatAt": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "The time of day when the refresh should run, for\n example, Monday-Sunday.
" + } + }, + "TopicScheduleType": { + "target": "com.amazonaws.quicksight#TopicScheduleType", + "traits": { + "smithy.api#documentation": "The type of refresh schedule. Valid values for this structure are HOURLY,\n DAILY,\n WEEKLY,\n and MONTHLY.
The tooltip.
\nThis is a union type structure. For this structure to be valid, only one of the attributes can be defined.
" + "smithy.api#documentation": "A structure that represents a topic refresh schedule.
" } }, - "com.amazonaws.quicksight#TooltipItemList": { + "com.amazonaws.quicksight#TopicRefreshScheduleSummaries": { "type": "list", "member": { - "target": "com.amazonaws.quicksight#TooltipItem" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } + "target": "com.amazonaws.quicksight#TopicRefreshScheduleSummary" } }, - "com.amazonaws.quicksight#TooltipOptions": { + "com.amazonaws.quicksight#TopicRefreshScheduleSummary": { "type": "structure", "members": { - "TooltipVisibility": { - "target": "com.amazonaws.quicksight#Visibility", + "DatasetId": { + "target": "com.amazonaws.quicksight#LimitedString", "traits": { - "smithy.api#documentation": "Determines whether or not the tooltip is visible.
" + "smithy.api#documentation": "The ID of the dataset.
" } }, - "SelectedTooltipType": { - "target": "com.amazonaws.quicksight#SelectedTooltipType", + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The selected type for the tooltip. Choose one of the following options:
\n\n BASIC: A basic tooltip.
\n DETAILED: A detailed tooltip.
The Amazon Resource Name (ARN) of the dataset.
" } }, - "FieldBasedTooltip": { - "target": "com.amazonaws.quicksight#FieldBasedTooltip", + "DatasetName": { + "target": "com.amazonaws.quicksight#LimitedString", "traits": { - "smithy.api#documentation": "The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
" + "smithy.api#documentation": "The name of the dataset.
" + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#TopicRefreshSchedule", + "traits": { + "smithy.api#documentation": "The definition of a refresh schedule.
" } } }, "traits": { - "smithy.api#documentation": "The display options for the visual tooltip.
" + "smithy.api#documentation": "A summary of the refresh schedule details for a dataset.
" } }, - "com.amazonaws.quicksight#TooltipTitleType": { + "com.amazonaws.quicksight#TopicRefreshStatus": { "type": "enum", "members": { - "NONE": { + "INITIALIZED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "NONE" + "smithy.api#enumValue": "INITIALIZED" } }, - "PRIMARY_VALUE": { + "RUNNING": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PRIMARY_VALUE" + "smithy.api#enumValue": "RUNNING" } - } - } - }, - "com.amazonaws.quicksight#TopBottomComputationType": { - "type": "enum", - "members": { - "TOP": { + }, + "FAILED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "TOP" + "smithy.api#enumValue": "FAILED" } }, - "BOTTOM": { + "COMPLETED": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "BOTTOM" + "smithy.api#enumValue": "COMPLETED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" } } } }, - "com.amazonaws.quicksight#TopBottomFilter": { + "com.amazonaws.quicksight#TopicRelativeDateFilter": { "type": "structure", "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", "traits": { - "smithy.api#documentation": "An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
", - "smithy.api#required": {} + "smithy.api#documentation": "The level of time precision that is used to aggregate DateTime values.
The column that the filter is applied to.
", - "smithy.api#required": {} + "smithy.api#documentation": "The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE, AFTER, and BETWEEN.
The number of items to include in the top bottom filter results.
" + "smithy.api#documentation": "The constant used in a\n relative date filter.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a relative date filter.
" + } + }, + "com.amazonaws.quicksight#TopicRelativeDateFilterFunction": { + "type": "enum", + "members": { + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREVIOUS" } }, - "AggregationSortConfigurations": { - "target": "com.amazonaws.quicksight#AggregationSortConfigurationList", + "THIS": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The aggregation and sort configuration of the top bottom filter.
", - "smithy.api#required": {} + "smithy.api#enumValue": "THIS" } }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", + "LAST": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The level of time precision that is used to aggregate DateTime values.
The parameter whose value should be used for the filter value.
" + "smithy.api#enumValue": "NEXT" + } + }, + "NOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOW" } } - }, - "traits": { - "smithy.api#documentation": "A TopBottomFilter filters values that are at the top or the bottom.
The ID for a computation.
", - "smithy.api#required": {} + "smithy.api#enumValue": "HOURLY" } }, - "Name": { - "target": "com.amazonaws.quicksight#String", + "DAILY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of a computation.
" + "smithy.api#enumValue": "DAILY" } }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", + "WEEKLY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The time field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#enumValue": "WEEKLY" } }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionField", + "MONTHLY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The category field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#enumValue": "MONTHLY" } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", + } + } + }, + "com.amazonaws.quicksight#TopicSingularFilterConstant": { + "type": "structure", + "members": { + "ConstantType": { + "target": "com.amazonaws.quicksight#ConstantType", "traits": { - "smithy.api#documentation": "The value field that is used in a computation.
" + "smithy.api#documentation": "The type of the singular filter constant. Valid values for this structure are SINGULAR.
The mover size setup of the top and bottom movers computation.
" + "smithy.api#documentation": "The value of the singular filter constant.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that represents a singular filter constant, used in filters to specify a single value to match against.
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#TopicSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicSummary" + } + }, + "com.amazonaws.quicksight#TopicSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic.
" } }, - "SortOrder": { - "target": "com.amazonaws.quicksight#TopBottomSortOrder", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#documentation": "The sort order setup of the top and bottom movers computation.
" + "smithy.api#documentation": "The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, - "Type": { - "target": "com.amazonaws.quicksight#TopBottomComputationType", + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", "traits": { - "smithy.api#documentation": "The computation type. Choose from the following options:
\nTOP: Top movers computation.
\nBOTTOM: Bottom movers computation.
\nThe name of the topic.
" } } }, "traits": { - "smithy.api#documentation": "The top movers and bottom movers computation setup.
" - } - }, - "com.amazonaws.quicksight#TopBottomMoversComputationMoverSize": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 20 - } + "smithy.api#documentation": "A topic summary.
" } }, - "com.amazonaws.quicksight#TopBottomRankedComputation": { - "type": "structure", + "com.amazonaws.quicksight#TopicTimeGranularity": { + "type": "enum", "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "SECOND": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The ID for a computation.
", - "smithy.api#required": {} + "smithy.api#enumValue": "SECOND" } }, - "Name": { - "target": "com.amazonaws.quicksight#String", + "MINUTE": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The name of a computation.
" + "smithy.api#enumValue": "MINUTE" } }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionField", + "HOUR": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The category field that is used in a computation.
", - "smithy.api#required": {} + "smithy.api#enumValue": "HOUR" } }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", + "DAY": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The value field that is used in a computation.
" + "smithy.api#enumValue": "DAY" } }, - "ResultSize": { - "target": "com.amazonaws.quicksight#TopBottomRankedComputationResultSize", + "WEEK": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The result size of a top and bottom ranked computation.
" + "smithy.api#enumValue": "WEEK" } }, - "Type": { - "target": "com.amazonaws.quicksight#TopBottomComputationType", + "MONTH": { + "target": "smithy.api#Unit", "traits": { - "smithy.api#documentation": "The computation type. Choose one of the following options:
\nTOP: A top ranked computation.
\nBOTTOM: A bottom ranked computation.
\nThe top ranked and bottom ranked computation configuration.
" - } - }, - "com.amazonaws.quicksight#TopBottomRankedComputationResultSize": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#TopBottomSortOrder": { - "type": "enum", - "members": { - "PERCENT_DIFFERENCE": { + }, + "QUARTER": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "PERCENT_DIFFERENCE" + "smithy.api#enumValue": "QUARTER" } }, - "ABSOLUTE_DIFFERENCE": { + "YEAR": { "target": "smithy.api#Unit", "traits": { - "smithy.api#enumValue": "ABSOLUTE_DIFFERENCE" + "smithy.api#enumValue": "YEAR" } } } @@ -36876,6 +41086,9 @@ }, "UntagColumnOperation": { "target": "com.amazonaws.quicksight#UntagColumnOperation" + }, + "OverrideDatasetParameterOperation": { + "target": "com.amazonaws.quicksight#OverrideDatasetParameterOperation" } }, "traits": { @@ -37131,6 +41344,15 @@ } } }, + "com.amazonaws.quicksight#TypeParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#LimitedString" + }, + "value": { + "target": "com.amazonaws.quicksight#LimitedString" + } + }, "com.amazonaws.quicksight#Typography": { "type": "structure", "members": { @@ -37321,6 +41543,23 @@ } } }, + "com.amazonaws.quicksight#UndefinedSpecifiedValueType": { + "type": "enum", + "members": { + "LEAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEAST" + } + }, + "MOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MOST" + } + } + } + }, "com.amazonaws.quicksight#UnicodeIcon": { "type": "string", "traits": { @@ -38580,6 +42819,12 @@ }, "DataSetUsageConfiguration": { "target": "com.amazonaws.quicksight#DataSetUsageConfiguration" + }, + "DatasetParameters": { + "target": "com.amazonaws.quicksight#DatasetParameterList", + "traits": { + "smithy.api#documentation": "The parameter declarations of the dataset.
" + } } }, "traits": { @@ -39232,7 +43477,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing IAM policy assignment. This operation updates only the optional\n\t\t\tparameter or parameters that are specified in the request.\n\t\t This overwrites all of the users included in Identities.\n\t\t
Updates an existing IAM policy assignment. This operation updates only\n\t\t\tthe optional parameter or parameters that are specified in the request. This overwrites\n\t\t\tall of the users included in Identities.
The ID of the Amazon Web Services account that contains the IAM policy assignment.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the IAM policy\n\t\t\tassignment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -39254,7 +43499,7 @@ "AssignmentName": { "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { - "smithy.api#documentation": "The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.
", + "smithy.api#documentation": "The name of the assignment, also called a rule.\n\t\t\tThe\n\t\t\tname must be unique within the\n\t\t\tAmazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -39270,19 +43515,19 @@ "AssignmentStatus": { "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "The status of the assignment. Possible values are as follows:
\n\n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.
\n DISABLED - This assignment isn't used when creating the data source.
\n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.
The status of the assignment. Possible values are as follows:
\n\n ENABLED - Anything specified in this assignment is used when\n\t\t\t\t\tcreating the data source.
\n DISABLED - This assignment isn't used when creating the data\n\t\t\t\t\tsource.
\n DRAFT - This assignment is an unfinished draft and isn't used\n\t\t\t\t\twhen creating the data source.
The ARN for the IAM policy to apply to the Amazon QuickSight users and groups\n\t\t\tspecified in this assignment.
" + "smithy.api#documentation": "The ARN for the IAM policy to apply to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.
" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "The Amazon QuickSight users, groups, or both that you want to assign the policy to.
" + "smithy.api#documentation": "The Amazon QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.
" } } }, @@ -39308,19 +43553,19 @@ "PolicyArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this\n\t\t\tassignment.
" + "smithy.api#documentation": "The ARN for the IAM policy applied to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.
" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
" + "smithy.api#documentation": "The Amazon QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.
" } }, "AssignmentStatus": { "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "The status of the assignment. Possible values are as follows:
\n\n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.
\n DISABLED - This assignment isn't used when creating the data source.
\n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.
The status of the assignment. Possible values are as follows:
\n\n ENABLED - Anything specified in this assignment is used when\n\t\t\t\t\tcreating the data source.
\n DISABLED - This assignment isn't used when creating the data\n\t\t\t\t\tsource.
\n DRAFT - This assignment is an unfinished draft and isn't used\n\t\t\t\t\twhen creating the data source.
Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.
Updates the content and status of IP rules. To use this operation, you\n\t\t\tmust\n\t\t\tprovide the entire map of rules. You can use the DescribeIpRestriction\n\t\t\toperation to get the current rule map.
Updates a template from an existing Amazon QuickSight analysis or another template.
", + "smithy.api#documentation": "Updates a template from an existing Amazon QuickSight analysis or another template.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTemplateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTemplateAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTemplateAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the template alias of a template.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTemplateAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the template alias that you're updating.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID for the template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "The alias of the template that you want to update. If you name a specific alias, you update\n\t\t\tthe version that the alias points to. You can specify the latest version of the template\n\t\t\tby providing the keyword $LATEST in the AliasName parameter.\n\t\t\tThe keyword $PUBLISHED doesn't apply to templates.
The version number of the template.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplateAliasResponse": { + "type": "structure", + "members": { + "TemplateAlias": { + "target": "com.amazonaws.quicksight#TemplateAlias", + "traits": { + "smithy.api#documentation": "The template alias.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplatePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTemplatePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the resource permissions for a template.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTemplatePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID for the template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "A list of resource permissions to be granted on the template.
" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "A list of resource permissions to be revoked from the template.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse": { + "type": "structure", + "members": { + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID for the template.
" + } + }, + "TemplateArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "A list of resource permissions to be set on the template.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplateRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the template that you're updating.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID for the template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#TemplateSourceEntity", + "traits": { + "smithy.api#documentation": "The entity that you are using as a source when you update the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.
Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.
A description of the current template version that is being updated. Every time you call\n\t\t\t\tUpdateTemplate, you create a new version of the template. Each version\n\t\t\tof the template maintains a description of the version in the\n\t\t\t\tVersionDescription field.
The name for the template.
" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#TemplateVersionDefinition", + "traits": { + "smithy.api#documentation": "The definition of a template.
\nA definition is the data model of all features in a Dashboard, Template, or Analysis.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplateResponse": { + "type": "structure", + "members": { + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID for the template.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the template.
" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The ARN for the template, including the version information of the first version.
" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "The creation status of the template.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateThemeRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateThemeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a theme.
", "smithy.api#http": { "method": "PUT", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", "code": 200 } } }, - "com.amazonaws.quicksight#UpdateTemplateAlias": { + "com.amazonaws.quicksight#UpdateThemeAlias": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#UpdateTemplateAliasRequest" + "target": "com.amazonaws.quicksight#UpdateThemeAliasRequest" }, "output": { - "target": "com.amazonaws.quicksight#UpdateTemplateAliasResponse" + "target": "com.amazonaws.quicksight#UpdateThemeAliasResponse" }, "errors": [ { @@ -39704,6 +44303,12 @@ { "target": "com.amazonaws.quicksight#InternalFailureException" }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, { "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, @@ -39715,29 +44320,29 @@ } ], "traits": { - "smithy.api#documentation": "Updates the template alias of a template.
", + "smithy.api#documentation": "Updates an alias of a theme.
", "smithy.api#http": { "method": "PUT", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", "code": 200 } } }, - "com.amazonaws.quicksight#UpdateTemplateAliasRequest": { + "com.amazonaws.quicksight#UpdateThemeAliasRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the template alias that you're updating.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the theme alias that you're updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "TemplateId": { + "ThemeId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID for the template.
", + "smithy.api#documentation": "The ID for the theme.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -39745,15 +44350,15 @@ "AliasName": { "target": "com.amazonaws.quicksight#AliasName", "traits": { - "smithy.api#documentation": "The alias of the template that you want to update. If you name a specific alias, you update\n\t\t\tthe version that the alias points to. You can specify the latest version of the template\n\t\t\tby providing the keyword $LATEST in the AliasName parameter.\n\t\t\tThe keyword $PUBLISHED doesn't apply to templates.
The name of the theme alias that you want to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "TemplateVersionNumber": { + "ThemeVersionNumber": { "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "The version number of the template.
", + "smithy.api#documentation": "The version number of the theme that the alias should reference.
", "smithy.api#required": {} } } @@ -39762,13 +44367,13 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#UpdateTemplateAliasResponse": { + "com.amazonaws.quicksight#UpdateThemeAliasResponse": { "type": "structure", "members": { - "TemplateAlias": { - "target": "com.amazonaws.quicksight#TemplateAlias", + "ThemeAlias": { + "target": "com.amazonaws.quicksight#ThemeAlias", "traits": { - "smithy.api#documentation": "The template alias.
" + "smithy.api#documentation": "Information about the theme alias.
" } }, "Status": { @@ -39790,17 +44395,17 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#UpdateTemplatePermissions": { + "com.amazonaws.quicksight#UpdateThemePermissions": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#UpdateTemplatePermissionsRequest" + "target": "com.amazonaws.quicksight#UpdateThemePermissionsRequest" }, "output": { - "target": "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse" + "target": "com.amazonaws.quicksight#UpdateThemePermissionsResponse" }, "errors": [ { - "target": "com.amazonaws.quicksight#ConflictException" + "target": "com.amazonaws.quicksight#AccessDeniedException" }, { "target": "com.amazonaws.quicksight#InternalFailureException" @@ -39822,29 +44427,29 @@ } ], "traits": { - "smithy.api#documentation": "Updates the resource permissions for a template.
", + "smithy.api#documentation": "Updates the resource permissions for a theme. Permissions apply to the action to grant or\n\t\t\trevoke permissions on, for example \"quicksight:DescribeTheme\".
Theme permissions apply in groupings. Valid groupings include the following for the three\n\t\t\tlevels of permissions, which are user, owner, or no permissions:
\nUser
\n\n \"quicksight:DescribeTheme\"\n
\n \"quicksight:DescribeThemeAlias\"\n
\n \"quicksight:ListThemeAliases\"\n
\n \"quicksight:ListThemeVersions\"\n
Owner
\n\n \"quicksight:DescribeTheme\"\n
\n \"quicksight:DescribeThemeAlias\"\n
\n \"quicksight:ListThemeAliases\"\n
\n \"quicksight:ListThemeVersions\"\n
\n \"quicksight:DeleteTheme\"\n
\n \"quicksight:UpdateTheme\"\n
\n \"quicksight:CreateThemeAlias\"\n
\n \"quicksight:DeleteThemeAlias\"\n
\n \"quicksight:UpdateThemeAlias\"\n
\n \"quicksight:UpdateThemePermissions\"\n
\n \"quicksight:DescribeThemePermissions\"\n
To specify no permissions, omit the permissions list.
\nThe ID of the Amazon Web Services account that contains the template.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the theme.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "TemplateId": { + "ThemeId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID for the template.
", + "smithy.api#documentation": "The ID for the theme.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -39852,13 +44457,13 @@ "GrantPermissions": { "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { - "smithy.api#documentation": "A list of resource permissions to be granted on the template.
" + "smithy.api#documentation": "A list of resource permissions to be granted for the theme.
" } }, "RevokePermissions": { "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { - "smithy.api#documentation": "A list of resource permissions to be revoked from the template.
" + "smithy.api#documentation": "A list of resource permissions to be revoked from the theme.
" } } }, @@ -39866,25 +44471,25 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse": { + "com.amazonaws.quicksight#UpdateThemePermissionsResponse": { "type": "structure", "members": { - "TemplateId": { + "ThemeId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID for the template.
" + "smithy.api#documentation": "The ID for the theme.
" } }, - "TemplateArn": { + "ThemeArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the theme.
" } }, "Permissions": { "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "A list of resource permissions to be set on the template.
" + "smithy.api#documentation": "The resulting list of resource permissions for the theme.
" } }, "RequestId": { @@ -39906,47 +44511,48 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#UpdateTemplateRequest": { + "com.amazonaws.quicksight#UpdateThemeRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the template that you're updating.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the theme that you're updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "TemplateId": { + "ThemeId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID for the template.
", + "smithy.api#documentation": "The ID for the theme.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#TemplateSourceEntity", + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", "traits": { - "smithy.api#documentation": "The entity that you are using as a source when you update the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.
Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.
The name for the theme.
" } }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", + "BaseThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "A description of the current template version that is being updated. Every time you call\n\t\t\t\tUpdateTemplate, you create a new version of the template. Each version\n\t\t\tof the template maintains a description of the version in the\n\t\t\t\tVersionDescription field.
The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.\n\t\tAll themes initially inherit from a default Amazon QuickSight theme.
", + "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", "traits": { - "smithy.api#documentation": "The name for the template.
" + "smithy.api#documentation": "A description of the theme version that you're updating Every time that you call\n\t\t\t\tUpdateTheme, you create a new version of the theme. Each version of the\n\t\t\ttheme maintains a description of the version in VersionDescription.
The definition of a template.
\nA definition is the data model of all features in a Dashboard, Template, or Analysis.
" + "smithy.api#documentation": "The theme configuration, which contains the theme display properties.
" } } }, @@ -39954,31 +44560,31 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#UpdateTemplateResponse": { + "com.amazonaws.quicksight#UpdateThemeResponse": { "type": "structure", "members": { - "TemplateId": { + "ThemeId": { "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID for the template.
" + "smithy.api#documentation": "The ID for the theme.
" } }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the template.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the theme.
" } }, "VersionArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The ARN for the template, including the version information of the first version.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the new version of the theme.
" } }, "CreationStatus": { "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "The creation status of the template.
" + "smithy.api#documentation": "The creation status of the theme.
" } }, "Status": { @@ -40000,18 +44606,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#UpdateTheme": { + "com.amazonaws.quicksight#UpdateTopic": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#UpdateThemeRequest" + "target": "com.amazonaws.quicksight#UpdateTopicRequest" }, "output": { - "target": "com.amazonaws.quicksight#UpdateThemeResponse" + "target": "com.amazonaws.quicksight#UpdateTopicResponse" }, "errors": [ { "target": "com.amazonaws.quicksight#AccessDeniedException" }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, { "target": "com.amazonaws.quicksight#InternalFailureException" }, @@ -40029,29 +44638,29 @@ }, { "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" } ], "traits": { - "smithy.api#documentation": "Updates a theme.
", + "smithy.api#documentation": "Updates a topic.
", "smithy.api#http": { "method": "PUT", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", "code": 200 } } }, - "com.amazonaws.quicksight#UpdateThemeAlias": { + "com.amazonaws.quicksight#UpdateTopicPermissions": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#UpdateThemeAliasRequest" + "target": "com.amazonaws.quicksight#UpdateTopicPermissionsRequest" }, "output": { - "target": "com.amazonaws.quicksight#UpdateThemeAliasResponse" + "target": "com.amazonaws.quicksight#UpdateTopicPermissionsResponse" }, "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, { "target": "com.amazonaws.quicksight#ConflictException" }, @@ -40062,7 +44671,7 @@ "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, { - "target": "com.amazonaws.quicksight#ResourceExistsException" + "target": "com.amazonaws.quicksight#LimitExceededException" }, { "target": "com.amazonaws.quicksight#ResourceNotFoundException" @@ -40075,46 +44684,43 @@ } ], "traits": { - "smithy.api#documentation": "Updates an alias of a theme.
", + "smithy.api#documentation": "Updates the permissions of a topic.
", "smithy.api#http": { "method": "PUT", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/permissions", "code": 200 } } }, - "com.amazonaws.quicksight#UpdateThemeAliasRequest": { + "com.amazonaws.quicksight#UpdateTopicPermissionsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the theme alias that you're updating.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the topic that you want to update\n the permissions for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#documentation": "The ID for the theme.
", + "smithy.api#documentation": "The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { - "smithy.api#documentation": "The name of the theme alias that you want to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The resource permissions that you want to grant to the topic.
" } }, - "ThemeVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { - "smithy.api#documentation": "The version number of the theme that the alias should reference.
", - "smithy.api#required": {} + "smithy.api#documentation": "The resource permissions that you want to revoke from the topic.
" } } }, @@ -40122,13 +44728,25 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#UpdateThemeAliasResponse": { + "com.amazonaws.quicksight#UpdateTopicPermissionsResponse": { "type": "structure", "members": { - "ThemeAlias": { - "target": "com.amazonaws.quicksight#ThemeAlias", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#documentation": "Information about the theme alias.
" + "smithy.api#documentation": "The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic.
" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "A list of resource permissions on the topic.
" } }, "Status": { @@ -40150,18 +44768,21 @@ "smithy.api#output": {} } }, - "com.amazonaws.quicksight#UpdateThemePermissions": { + "com.amazonaws.quicksight#UpdateTopicRefreshSchedule": { "type": "operation", "input": { - "target": "com.amazonaws.quicksight#UpdateThemePermissionsRequest" + "target": "com.amazonaws.quicksight#UpdateTopicRefreshScheduleRequest" }, "output": { - "target": "com.amazonaws.quicksight#UpdateThemePermissionsResponse" + "target": "com.amazonaws.quicksight#UpdateTopicRefreshScheduleResponse" }, "errors": [ { "target": "com.amazonaws.quicksight#AccessDeniedException" }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, { "target": "com.amazonaws.quicksight#InternalFailureException" }, @@ -40172,53 +44793,56 @@ "target": "com.amazonaws.quicksight#LimitExceededException" }, { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" + "target": "com.amazonaws.quicksight#ResourceExistsException" }, { - "target": "com.amazonaws.quicksight#ThrottlingException" + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + "target": "com.amazonaws.quicksight#ThrottlingException" } ], "traits": { - "smithy.api#documentation": "Updates the resource permissions for a theme. Permissions apply to the action to grant or\n\t\t\trevoke permissions on, for example \"quicksight:DescribeTheme\".
Theme permissions apply in groupings. Valid groupings include the following for the three\n\t\t\tlevels of permissions, which are user, owner, or no permissions:
\nUser
\n\n \"quicksight:DescribeTheme\"\n
\n \"quicksight:DescribeThemeAlias\"\n
\n \"quicksight:ListThemeAliases\"\n
\n \"quicksight:ListThemeVersions\"\n
Owner
\n\n \"quicksight:DescribeTheme\"\n
\n \"quicksight:DescribeThemeAlias\"\n
\n \"quicksight:ListThemeAliases\"\n
\n \"quicksight:ListThemeVersions\"\n
\n \"quicksight:DeleteTheme\"\n
\n \"quicksight:UpdateTheme\"\n
\n \"quicksight:CreateThemeAlias\"\n
\n \"quicksight:DeleteThemeAlias\"\n
\n \"quicksight:UpdateThemeAlias\"\n
\n \"quicksight:UpdateThemePermissions\"\n
\n \"quicksight:DescribeThemePermissions\"\n
To specify no permissions, omit the permissions list.
\nUpdates a topic refresh schedule.
", "smithy.api#http": { "method": "PUT", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/permissions", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", "code": 200 } } }, - "com.amazonaws.quicksight#UpdateThemePermissionsRequest": { + "com.amazonaws.quicksight#UpdateTopicRefreshScheduleRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the theme.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the topic whose refresh schedule\n you want to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#documentation": "The ID for the theme.
", + "smithy.api#documentation": "The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "DatasetId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "A list of resource permissions to be granted for the theme.
" + "smithy.api#documentation": "The ID of the dataset.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#TopicRefreshSchedule", "traits": { - "smithy.api#documentation": "A list of resource permissions to be revoked from the theme.
" + "smithy.api#documentation": "The definition of a refresh schedule.
", + "smithy.api#required": {} } } }, @@ -40226,31 +44850,25 @@ "smithy.api#input": {} } }, - "com.amazonaws.quicksight#UpdateThemePermissionsResponse": { + "com.amazonaws.quicksight#UpdateTopicRefreshScheduleResponse": { "type": "structure", "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#documentation": "The ID for the theme.
" + "smithy.api#documentation": "The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, - "ThemeArn": { + "TopicArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the theme.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic.
" } }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "The resulting list of resource permissions for the theme.
" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" } }, "Status": { @@ -40260,86 +44878,74 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } } }, "traits": { "smithy.api#output": {} } }, - "com.amazonaws.quicksight#UpdateThemeRequest": { + "com.amazonaws.quicksight#UpdateTopicRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the theme that you're updating.
", + "smithy.api#documentation": "The ID of the Amazon Web Services account that contains the topic that you want to\n update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#documentation": "The ID for the theme.
", + "smithy.api#documentation": "The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "The name for the theme.
" - } - }, - "BaseThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "Topic": { + "target": "com.amazonaws.quicksight#TopicDetails", "traits": { - "smithy.api#documentation": "The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.\n\t\tAll themes initially inherit from a default Amazon QuickSight theme.
", + "smithy.api#documentation": "The definition of the topic that you want to update.
", "smithy.api#required": {} } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "A description of the theme version that you're updating Every time that you call\n\t\t\t\tUpdateTheme, you create a new version of the theme. Each version of the\n\t\t\ttheme maintains a description of the version in VersionDescription.
The theme configuration, which contains the theme display properties.
" - } } }, "traits": { "smithy.api#input": {} } }, - "com.amazonaws.quicksight#UpdateThemeResponse": { + "com.amazonaws.quicksight#UpdateTopicResponse": { "type": "structure", "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", "traits": { - "smithy.api#documentation": "The ID for the theme.
" + "smithy.api#documentation": "The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
" } }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the theme.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic.
" } }, - "VersionArn": { + "RefreshArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the new version of the theme.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the topic refresh.
" } }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The creation status of the theme.
" + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" } }, "Status": { @@ -40349,12 +44955,6 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" - } } }, "traits": { @@ -40506,6 +45106,153 @@ "smithy.api#output": {} } }, + "com.amazonaws.quicksight#UpdateVPCConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateVPCConnectionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateVPCConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a VPC connection.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateVPCConnectionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account ID of the account that contains the VPC connection that\n\t\t\tyou want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "The ID of the VPC connection that\n\t\t\tyou're updating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "The display name for the VPC connection.
", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.quicksight#SubnetIdList", + "traits": { + "smithy.api#documentation": "A list of subnet IDs for the VPC connection.
", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "A list of security group IDs for the VPC connection.
", + "smithy.api#required": {} + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#DnsResolverList", + "traits": { + "smithy.api#documentation": "A list of IP addresses of DNS resolver endpoints for the VPC connection.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "An IAM role associated with the VPC connection.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateVPCConnectionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the VPC connection.
" + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.
" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "The update status of the VPC connection's last update.
" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "The availability status of the VPC connection.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon Web Services request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.quicksight#UploadSettings": { "type": "structure", "members": { @@ -40680,6 +45427,273 @@ } } }, + "com.amazonaws.quicksight#VPCConnection": { + "type": "structure", + "members": { + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n Amazon Web Services account.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the VPC connection.
" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "The display name for the VPC connection.
" + } + }, + "VPCId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon EC2 VPC ID associated with the VPC connection.
" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "The Amazon EC2 security group IDs associated with the VPC connection.
" + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "A list of IP addresses of DNS resolver endpoints for the VPC connection.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "The status of the VPC connection.
" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "The availability status of the VPC connection.
" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.quicksight#NetworkInterfaceList", + "traits": { + "smithy.api#documentation": "A list of network interfaces.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ARN of the\n IAM role associated with the VPC\n connection.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the VPC connection was created.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the VPC connection was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The structure of a VPC connection.
" + } + }, + "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + }, + "PARTIALLY_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIALLY_AVAILABLE" + } + } + } + }, + "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[\\w\\-]+$" + } + }, + "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#VPCConnectionResourceStatus": { + "type": "enum", + "members": { + "CREATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_IN_PROGRESS" + } + }, + "CREATION_SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_SUCCESSFUL" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_SUCCESSFUL" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_IN_PROGRESS" + } + }, + "DELETION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.quicksight#VPCConnectionSummary": { + "type": "structure", + "members": { + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "The ID of the VPC connection that\n you're\n creating. This ID is a unique identifier for each Amazon Web Services Region in an\n Amazon Web Services account.
" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the VPC connection.
" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "The display name for the VPC connection.
" + } + }, + "VPCId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The Amazon EC2 VPC ID associated with the VPC connection.
" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "The Amazon EC2 security group IDs associated with the VPC connection.
" + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "A list of IP addresses of DNS resolver endpoints for the VPC connection.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "The status of the VPC connection.
" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "The availability status of the VPC connection.
" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.quicksight#NetworkInterfaceList", + "traits": { + "smithy.api#documentation": "A list of network interfaces.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The ARN of the IAM role associated\n with the VPC connection.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the VPC connection was created.
" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the VPC connection was last updated.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary metadata that describes a VPC connection.
" + } + }, + "com.amazonaws.quicksight#VPCConnectionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#VPCConnectionSummary" + } + }, "com.amazonaws.quicksight#ValueWhenUnsetOption": { "type": "enum", "members": { @@ -41078,7 +46092,7 @@ "traits": { "smithy.api#length": { "min": 0, - "max": 30 + "max": 50 } } }, diff --git a/codegen/sdk-codegen/aws-models/rekognition.json b/codegen/sdk-codegen/aws-models/rekognition.json index 44822bed5f9..ef4370503ae 100644 --- a/codegen/sdk-codegen/aws-models/rekognition.json +++ b/codegen/sdk-codegen/aws-models/rekognition.json @@ -101,6 +101,72 @@ "traits": { "smithy.api#enumValue": "ALL" } + }, + "AGE_RANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AGE_RANGE" + } + }, + "BEARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEARD" + } + }, + "EMOTIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMOTIONS" + } + }, + "EYEGLASSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EYEGLASSES" + } + }, + "EYES_OPEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EYES_OPEN" + } + }, + "GENDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENDER" + } + }, + "MOUTH_OPEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MOUTH_OPEN" + } + }, + "MUSTACHE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MUSTACHE" + } + }, + "FACE_OCCLUDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACE_OCCLUDED" + } + }, + "SMILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMILE" + } + }, + "SUNGLASSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUNGLASSES" + } } } }, @@ -1222,7 +1288,7 @@ "OutputConfig": { "target": "com.amazonaws.rekognition#LivenessOutputConfig", "traits": { - "smithy.api#documentation": "Can specify the location of an Amazon S3 bucket, where reference and audit images will be\n stored. Note that the Amazon S3 bucket must be located in the caller's AWS account and in the same\n region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are auto-generated by\n the Face Liveness system.
" + "smithy.api#documentation": "Can specify the location of an Amazon S3 bucket, where reference and audit images will be\n stored. Note that the Amazon S3 bucket must be located in the caller's AWS account and in the\n same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are\n auto-generated by the Face Liveness system. Requires that the caller has the\n s3:PutObject permission on the Amazon S3 bucket.
Detects faces within an image that is provided as input.
\n\n DetectFaces detects the 100 largest faces in the image. For each face\n detected, the operation returns face details. These details include a bounding box of the\n face, a confidence value (that the bounding box contains a face), and a fixed set of\n attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of\n beard, sunglasses, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or\n obscured faces, the algorithm might not detect the faces or might detect faces with lower\n confidence.
\nYou pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
\nThis is a stateless API operation. That is, the operation does not persist any\n data.
\nThis operation requires permissions to perform the rekognition:DetectFaces\n action.
Detects faces within an image that is provided as input.
\n\n DetectFaces detects the 100 largest faces in the image. For each face\n detected, the operation returns face details. These details include a bounding box of the\n face, a confidence value (that the bounding box contains a face), and a fixed set of\n attributes such as facial landmarks (for example, coordinates of eye and mouth), pose,\n presence of facial occlusion, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or\n obscured faces, the algorithm might not detect the faces or might detect faces with lower\n confidence.
\nYou pass the input image either as base64-encoded image bytes or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
\nThis is a stateless API operation. That is, the operation does not persist any\n data.
\nThis operation requires permissions to perform the rekognition:DetectFaces\n action.
An array of facial attributes you want to be returned. This can be the default list of\n attributes or all attributes. If you don't specify a value for Attributes or if\n you specify [\"DEFAULT\"], the API returns the following subset of facial\n attributes: BoundingBox, Confidence, Pose,\n Quality, and Landmarks. If you provide [\"ALL\"], all\n facial attributes are returned, but the operation takes longer to complete.
If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical AND\n operator to determine which attributes to return (in this case, all attributes).
An array of facial attributes you want to be returned. A DEFAULT subset of\n facial attributes - BoundingBox, Confidence, Pose,\n Quality, and Landmarks - will always be returned. You can request\n for specific facial attributes (in addition to the default list) - by using [\"DEFAULT\",\n \"FACE_OCCLUDED\"] or just [\"FACE_OCCLUDED\"]. You can request for all\n facial attributes by using [\"ALL\"]. Requesting more attributes may increase\n response time.
If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical \"AND\"\n operator to determine which attributes to return (in this case, all attributes).
Confidence level that the bounding box contains a face (and not a different object such\n as a tree). Default attribute.
" } + }, + "FaceOccluded": { + "target": "com.amazonaws.rekognition#FaceOccluded", + "traits": { + "smithy.api#documentation": "\n FaceOccluded should return \"true\" with a high confidence score if a detected\n face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark\n sunglasses, cell phones, hands, or other objects. FaceOccluded should return\n \"false\" with a high confidence score if common occurrences that do not impact face\n verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair,\n and others.
True if a detected face’s eyes, nose, and mouth are partially captured or if they are\n covered by masks, dark sunglasses, cell phones, hands, or other objects. False if common\n occurrences that do not impact face verification are detected, such as eye glasses, lightly\n tinted sunglasses, strands of hair, and others.
" + } + }, + "Confidence": { + "target": "com.amazonaws.rekognition#Percent", + "traits": { + "smithy.api#documentation": "The confidence that the service has detected the presence of a face occlusion.
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n FaceOccluded should return \"true\" with a high confidence score if a detected\n face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark\n sunglasses, cell phones, hands, or other objects. FaceOccluded should return\n \"false\" with a high confidence score if common occurrences that do not impact face\n verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair,\n and others.
You can use FaceOccluded to determine if an obstruction on a face negatively\n impacts using the image for face matching.
Detects faces in the input image and adds them to the specified collection.
\nAmazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage operations.
\nFor more information, see Adding faces to a collection in the Amazon Rekognition\n Developer Guide.
\nTo get the number of faces in a collection, call DescribeCollection.
\nIf you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information is not\n returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model\n version from the value of FaceModelVersion in the response from\n IndexFaces\n
For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.
\nIf you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want\n to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. By default, IndexFaces chooses the quality bar that's used to filter\n faces. You can also explicitly choose the quality bar. Use QualityFilter, to set\n the quality bar by specifying LOW, MEDIUM, or HIGH. If\n you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.
\nInformation about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't indexed\n for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request\n parameter.
The face is too small compared to the image dimensions.
\nThe face is too blurry.
\nThe image is too dark.
\nThe face has an extreme pose.
\nThe face doesn’t have enough detail to be suitable for face search.
\nIn response, the IndexFaces operation returns an array of metadata for all\n detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected\n and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide the same\n image, specify the same collection, and use the same external ID in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
\nThis operation requires permissions to perform the rekognition:IndexFaces\n action.
Detects faces in the input image and adds them to the specified collection.
\nAmazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage operations.
\nFor more information, see Adding faces to a collection in the Amazon Rekognition\n Developer Guide.
\nTo get the number of faces in a collection, call DescribeCollection.
\nIf you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information is not\n returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection and supply the collection ID. You can also get the model\n version from the value of FaceModelVersion in the response from\n IndexFaces\n
For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.
\nIf you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want\n to index smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a variety of common use\n cases. By default, IndexFaces chooses the quality bar that's used to filter\n faces. You can also explicitly choose the quality bar. Use QualityFilter, to set\n the quality bar by specifying LOW, MEDIUM, or HIGH. If\n you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the face\n model or higher. To get the version of the face model associated with a collection, call\n DescribeCollection.
\nInformation about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't indexed\n for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request\n parameter.
The face is too small compared to the image dimensions.
\nThe face is too blurry.
\nThe image is too dark.
\nThe face has an extreme pose.
\nThe face doesn’t have enough detail to be suitable for face search.
\nIn response, the IndexFaces operation returns an array of metadata for all\n detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected\n and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request ALL or specific facial attributes (e.g.,\n FACE_OCCLUDED) by using the detectionAttributes parameter, Amazon Rekognition\n returns detailed facial attributes, such as facial landmarks (for example, location of eye and\n mouth), facial occlusion, and other facial attributes.
If you provide the same image, specify the same collection, and use the same external ID\n in the IndexFaces operation, Amazon Rekognition doesn't save duplicate face\n metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
\nThis operation requires permissions to perform the rekognition:IndexFaces\n action.
An array of facial attributes that you want to be returned. This can be the default\n list of attributes or all attributes. If you don't specify a value for Attributes\n or if you specify [\"DEFAULT\"], the API returns the following subset of facial\n attributes: BoundingBox, Confidence, Pose,\n Quality, and Landmarks. If you provide [\"ALL\"], all\n facial attributes are returned, but the operation takes longer to complete.
If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical AND\n operator to determine which attributes to return (in this case, all attributes).
An array of facial attributes you want to be returned. A DEFAULT subset of\n facial attributes - BoundingBox, Confidence, Pose,\n Quality, and Landmarks - will always be returned. You can request\n for specific facial attributes (in addition to the default list) - by using [\"DEFAULT\",\n \"FACE_OCCLUDED\"] or just [\"FACE_OCCLUDED\"]. You can request for all\n facial attributes by using [\"ALL\"]. Requesting more attributes may increase\n response time.
If you provide both, [\"ALL\", \"DEFAULT\"], the service uses a logical AND\n operator to determine which attributes to return (in this case, all attributes).
Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will\n wait before permanently removing all parts of the upload. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the\n Amazon S3 User Guide.
" + "smithy.api#documentation": "Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will\n wait before permanently removing all parts of the upload. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the\n Amazon S3 User Guide.
" } }, "com.amazonaws.s3#AbortMultipartUpload": { @@ -61,7 +61,7 @@ } ], "traits": { - "smithy.api#documentation": "This action aborts a multipart upload. After a multipart upload is aborted, no\n additional parts can be uploaded using that upload ID. The storage consumed by any\n previously uploaded parts will be freed. However, if any part uploads are currently in\n progress, those part uploads might or might not succeed. As a result, it might be necessary\n to abort a given multipart upload multiple times in order to completely free all storage\n consumed by all parts.
\nTo verify that all parts have been removed, so you don't get charged for the part\n storage, you should call the ListParts action and ensure that\n the parts list is empty.
\nFor information about permissions required to use the multipart upload, see Multipart Upload and\n Permissions.
\nThe following operations are related to AbortMultipartUpload:
\n UploadPart\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThis action aborts a multipart upload. After a multipart upload is aborted, no\n additional parts can be uploaded using that upload ID. The storage consumed by any\n previously uploaded parts will be freed. However, if any part uploads are currently in\n progress, those part uploads might or might not succeed. As a result, it might be necessary\n to abort a given multipart upload multiple times in order to completely free all storage\n consumed by all parts.
\nTo verify that all parts have been removed, so you don't get charged for the part\n storage, you should call the ListParts action and ensure that\n the parts list is empty.
\nFor information about permissions required to use the multipart upload, see Multipart Upload\n and Permissions.
\nThe following operations are related to AbortMultipartUpload:
\n UploadPart\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThe bucket name to which the upload was taking place.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The bucket name to which the upload was taking place.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
" + "smithy.api#documentation": "Specifies the configuration and any analyses for the analytics filter of an Amazon S3\n bucket.
" } }, "com.amazonaws.s3#AnalyticsConfigurationList": { @@ -19326,7 +19326,7 @@ "CreationDate": { "target": "com.amazonaws.s3#CreationDate", "traits": { - "smithy.api#documentation": "Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.
" + "smithy.api#documentation": "Date the bucket was created. This date can change when making changes to your bucket,\n such as editing its bucket policy.
" } } }, @@ -19681,7 +19681,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling\n Cross-Origin Resource Sharing in the Amazon S3 User Guide.
" + "smithy.api#documentation": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling\n Cross-Origin Resource Sharing in the\n Amazon S3 User Guide.
" } }, "com.amazonaws.s3#CORSRule": { @@ -19757,7 +19757,7 @@ "Comments": { "target": "com.amazonaws.s3#Comments", "traits": { - "smithy.api#documentation": "A single character used to indicate that a row should be ignored when the character is\n present at the start of that row. You can specify any character to indicate a comment\n line.
" + "smithy.api#documentation": "A single character used to indicate that a row should be ignored when the character is\n present at the start of that row. You can specify any character to indicate a comment line.\n The default character is #.
Default: #\n
Completes a multipart upload by assembling previously uploaded parts.
\nYou first initiate the multipart upload and then upload all parts using the UploadPart\n operation. After successfully uploading all relevant parts of an upload, you call this\n action to complete the upload. Upon receiving this request, Amazon S3 concatenates all\n the parts in ascending order by part number to create a new object. In the Complete\n Multipart Upload request, you must provide the parts list. You must ensure that the parts\n list is complete. This action concatenates the parts that you provide in the list. For\n each part in the list, you must provide the part number and the ETag value,\n returned after that part was uploaded.
Processing of a Complete Multipart Upload request could take several minutes to\n complete. After Amazon S3 begins processing the request, it sends an HTTP response header that\n specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white\n space characters to keep the connection from timing out. Because a request could fail after\n the initial 200 OK response has been sent, it is important that you check the response body\n to determine whether the request succeeded.
\nNote that if CompleteMultipartUpload fails, applications should be prepared\n to retry the failed requests. For more information, see Amazon S3 Error Best Practices.
You cannot use Content-Type: application/x-www-form-urlencoded with Complete\n Multipart Upload requests. Also, if you do not provide a Content-Type header, CompleteMultipartUpload returns a 200 OK response.
For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload.
\nFor information about permissions required to use the multipart upload API, see Multipart Upload and\n Permissions.
\n\n CompleteMultipartUpload has the following special errors:
Error code: EntityTooSmall\n
Description: Your proposed upload is smaller than the minimum allowed object\n size. Each part must be at least 5 MB in size, except the last part.
\n400 Bad Request
\nError code: InvalidPart\n
Description: One or more of the specified parts could not be found. The part\n might not have been uploaded, or the specified entity tag might not have\n matched the part's entity tag.
\n400 Bad Request
\nError code: InvalidPartOrder\n
Description: The list of parts was not in ascending order. The parts list\n must be specified in order by part number.
\n400 Bad Request
\nError code: NoSuchUpload\n
Description: The specified multipart upload does not exist. The upload ID\n might be invalid, or the multipart upload might have been aborted or\n completed.
\n404 Not Found
\nThe following operations are related to CompleteMultipartUpload:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nCompletes a multipart upload by assembling previously uploaded parts.
\nYou first initiate the multipart upload and then upload all parts using the UploadPart\n operation. After successfully uploading all relevant parts of an upload, you call this\n action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the\n parts in ascending order by part number to create a new object. In the Complete Multipart\n Upload request, you must provide the parts list. You must ensure that the parts list is\n complete. This action concatenates the parts that you provide in the list. For each part in\n the list, you must provide the part number and the ETag value, returned after\n that part was uploaded.
Processing of a Complete Multipart Upload request could take several minutes to\n complete. After Amazon S3 begins processing the request, it sends an HTTP response header that\n specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white\n space characters to keep the connection from timing out. A request could fail after the\n initial 200 OK response has been sent. This means that a 200 OK response can\n contain either a success or an error. If you call the S3 API directly, make sure to design\n your application to parse the contents of the response and handle it appropriately. If you\n use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply\n error handling per your configuration settings (including automatically retrying the\n request as appropriate). If the condition persists, the SDKs throws an exception (or, for\n the SDKs that don't use exceptions, they return the error).
Note that if CompleteMultipartUpload fails, applications should be prepared\n to retry the failed requests. For more information, see Amazon S3 Error Best\n Practices.
You cannot use Content-Type: application/x-www-form-urlencoded with\n Complete Multipart Upload requests. Also, if you do not provide a\n Content-Type header, CompleteMultipartUpload returns a 200\n OK response.
For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload.
\nFor information about permissions required to use the multipart upload API, see Multipart Upload\n and Permissions.
\n\n CompleteMultipartUpload has the following special errors:
Error code: EntityTooSmall\n
Description: Your proposed upload is smaller than the minimum allowed object\n size. Each part must be at least 5 MB in size, except the last part.
\n400 Bad Request
\nError code: InvalidPart\n
Description: One or more of the specified parts could not be found. The part\n might not have been uploaded, or the specified entity tag might not have\n matched the part's entity tag.
\n400 Bad Request
\nError code: InvalidPartOrder\n
Description: The list of parts was not in ascending order. The parts list\n must be specified in order by part number.
\n400 Bad Request
\nError code: NoSuchUpload\n
Description: The specified multipart upload does not exist. The upload ID\n might be invalid, or the multipart upload might have been aborted or\n completed.
\n404 Not Found
\nThe following operations are related to CompleteMultipartUpload:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThe name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The name of the bucket that contains the newly created object. Does not return the access point\n ARN or access point alias if used.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Entity tag that identifies the newly created object's data. Objects with different\n object data will have different entity tags. The entity tag is an opaque string. The entity\n tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5\n digest of the object data, it will contain one or more nonhexadecimal characters and/or\n will consist of less than 32 or more than 32 hexadecimal digits. For more information about\n how the entity tag is calculated, see\n Checking\n object integrity in the Amazon S3 User Guide.
" + "smithy.api#documentation": "Entity tag that identifies the newly created object's data. Objects with different\n object data will have different entity tags. The entity tag is an opaque string. The entity\n tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5\n digest of the object data, it will contain one or more nonhexadecimal characters and/or\n will consist of less than 32 or more than 32 hexadecimal digits. For more information about\n how the entity tag is calculated, see Checking object\n integrity in the Amazon S3 User Guide.
" } }, "ChecksumCRC32": { @@ -20031,7 +20031,7 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "If you specified server-side encryption either with an Amazon S3-managed encryption key or an\n Amazon Web Services KMS key in your initiate multipart upload request, the response\n includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the\n object.
", + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed key that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -20053,7 +20053,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Amazon Web Services KMS (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -20075,7 +20075,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "Name of the bucket to which the multipart upload was initiated.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
Name of the bucket to which the multipart upload was initiated.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Array of CompletedPart data types.
\nIf you do not supply a valid Part with your request, the service sends back an HTTP\n 400 response.
Array of CompletedPart data types.
\nIf you do not supply a valid Part with your request, the service sends back\n an HTTP 400 response.
Creates a copy of an object that is already stored in Amazon S3.
\nYou can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic action using this API. However, to copy an\n object greater than 5 GB, you must use the multipart upload Upload Part - Copy\n (UploadPartCopy) API. For more information, see Copy Object Using the\n REST Multipart Upload API.
\nAll copy requests must be authenticated. Additionally, you must have\n read access to the source object and write\n access to the destination bucket. For more information, see REST Authentication. Both the Region\n that you want to copy the object from and the Region that you want to copy the object to\n must be enabled for your account.
\nA copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n is copying the files. If the error occurs before the copy action starts, you receive a\n standard Amazon S3 error. If the error occurs during the copy operation, the error response is\n embedded in the 200 OK response. This means that a 200 OK\n response can contain either a success or an error. Design your application to parse the\n contents of the response and handle it appropriately.
If the copy is successful, you receive a response with information about the copied\n object.
\nIf the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.
\nThe copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.
\nAmazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request error. For more information, see Transfer Acceleration.
\n Metadata\n
\nWhen copying an object, you can preserve all metadata (default) or specify new metadata.\n However, the ACL is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.
\nTo specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 User Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.
\n x-amz-copy-source-if Headers\n
\nTo only copy an object under certain conditions, such as whether the Etag\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:
\n x-amz-copy-source-if-match\n
\n x-amz-copy-source-if-none-match\n
\n x-amz-copy-source-if-unmodified-since\n
\n x-amz-copy-source-if-modified-since\n
If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:
\n x-amz-copy-source-if-match condition evaluates to true
\n x-amz-copy-source-if-unmodified-since condition evaluates to\n false
If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:
\n x-amz-copy-source-if-none-match condition evaluates to false
\n x-amz-copy-source-if-modified-since condition evaluates to\n true
All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed.
\n Server-side encryption\n
\nWhen you perform a CopyObject operation, you can optionally use the appropriate encryption-related \n headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys \n (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 \n encrypts your data as it writes it to disks in its data centers and decrypts the data when \n you access it. For more information about server-side encryption, see Using\n Server-Side Encryption.
\nIf a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more\n information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
\n\n Access Control List (ACL)-Specific Request\n Headers\n
\nWhen copying an object, you can optionally use headers to grant ACL-based permissions.\n By default, all objects are private. Only the owner has full access control. When adding a\n new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups\n defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.
\nIf the bucket that you're copying objects to uses the bucket owner enforced setting for\n S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control canned\n ACL or an equivalent form of this ACL expressed in the XML format.
For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for Object Ownership, \n all objects written to the bucket by any account will be owned by the bucket owner.
\n\n Checksums\n
\nWhen copying an object, if it has a checksum, that checksum will be copied to the new object\n by default. When you copy the object over, you may optionally specify a different checksum\n algorithm to use with the x-amz-checksum-algorithm header.
\n Storage Class Options\n
\nYou can use the CopyObject action to change the storage class of an\n object that is already stored in Amazon S3 using the StorageClass parameter. For\n more information, see Storage\n Classes in the Amazon S3 User Guide.
\n Versioning\n
\nBy default, x-amz-copy-source identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n 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\n the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n 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\n Amazon S3 generates is always null.
\nIf the source object's storage class is GLACIER, you must restore a copy of this object\n before you can use it as a source object for the copy operation. For more information, see\n RestoreObject.
\nThe following operations are related to CopyObject:
For more information, see Copying\n Objects.
", + "smithy.api#documentation": "Creates a copy of an object that is already stored in Amazon S3.
\nYou can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic action using this API. However, to copy an\n object greater than 5 GB, you must use the multipart upload Upload Part - Copy\n (UploadPartCopy) API. For more information, see Copy Object Using the\n REST Multipart Upload API.
\nAll copy requests must be authenticated. Additionally, you must have\n read access to the source object and write\n access to the destination bucket. For more information, see REST Authentication. Both the\n Region that you want to copy the object from and the Region that you want to copy the\n object to must be enabled for your account.
\nA copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n is copying the files. If the error occurs before the copy action starts, you receive a\n standard Amazon S3 error. If the error occurs during the copy operation, the error response is\n embedded in the 200 OK response. This means that a 200 OK\n response can contain either a success or an error. If you call the S3 API directly, make\n sure to design your application to parse the contents of the response and handle it\n appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the\n embedded error and apply error handling per your configuration settings (including\n automatically retrying the request as appropriate). If the condition persists, the SDKs\n throws an exception (or, for the SDKs that don't use exceptions, they return the\n error).
If the copy is successful, you receive a response with information about the copied\n object.
\nIf the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.
\nThe copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.
\nAmazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request error. For more information, see Transfer\n Acceleration.
When copying an object, you can preserve all metadata (default) or specify new metadata.\n However, the ACL is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.
\nTo specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 User Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.
\n x-amz-website-redirect-location is unique to each object and must be\n specified in the request headers to copy the value.
To only copy an object under certain conditions, such as whether the Etag\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:
\n x-amz-copy-source-if-match\n
\n x-amz-copy-source-if-none-match\n
\n x-amz-copy-source-if-unmodified-since\n
\n x-amz-copy-source-if-modified-since\n
If both the x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK and copies the data:
\n x-amz-copy-source-if-match condition evaluates to true
\n x-amz-copy-source-if-unmodified-since condition evaluates to\n false
If both the x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed response\n code:
\n x-amz-copy-source-if-none-match condition evaluates to false
\n x-amz-copy-source-if-modified-since condition evaluates to\n true
All headers with the x-amz- prefix, including\n x-amz-copy-source, must be signed.
Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When\n copying an object, if you don't specify encryption information in your copy request, the\n encryption setting of the target object is set to the default encryption configuration of\n the destination bucket. By default, all buckets have a base level of encryption\n configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the\n destination bucket has a default encryption configuration that uses server-side encryption\n with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C),\n Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target\n object copy.
\nWhen you perform a CopyObject operation, if you want to use a different type\n of encryption setting for the target object, you can use other appropriate\n encryption-related headers to encrypt the target object with a KMS key, an Amazon S3 managed\n key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts the data when you access it. If the\n encryption setting in your request is different from the default encryption configuration\n of the destination bucket, the encryption setting in your request takes precedence. If the\n source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary\n encryption information in your request so that Amazon S3 can decrypt the object for copying. For\n more information about server-side encryption, see Using Server-Side\n Encryption.
\nIf a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For\n more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
\nWhen copying an object, you can optionally use headers to grant ACL-based permissions.\n By default, all objects are private. Only the owner has full access control. When adding a\n new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups\n defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.
\nIf the bucket that you're copying objects to uses the bucket owner enforced setting for\n S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use\n this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent form of this ACL expressed in the XML format.
For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for Object Ownership, all\n objects written to the bucket by any account will be owned by the bucket owner.
\nWhen copying an object, if it has a checksum, that checksum will be copied to the new\n object by default. When you copy the object over, you may optionally specify a different\n checksum algorithm to use with the x-amz-checksum-algorithm header.
You can use the CopyObject action to change the storage class of an object\n that is already stored in Amazon S3 using the StorageClass parameter. For more\n information, see Storage Classes in the\n Amazon S3 User Guide.
If the source object's storage class is GLACIER, you must restore a copy of\n this object before you can use it as a source object for the copy operation. For\n more information, see RestoreObject. For\n more information, see Copying\n Objects.
\nBy default, x-amz-copy-source identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n 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\n the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n 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\n Amazon S3 generates is always null.
\nThe following operations are related to CopyObject:
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed key that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -20413,7 +20413,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the copied object uses an S3 Bucket Key for server-side encryption\n with Amazon Web Services KMS (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -20441,7 +20441,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The name of the destination bucket.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The name of the destination bucket.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-full-control" } }, "GrantRead": { "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "Allows grantee to read the object data and its\n metadata.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Allows grantee to read the object data and its metadata.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-read" } }, @@ -20558,7 +20558,7 @@ "GrantWriteACP": { "target": "com.amazonaws.s3#GrantWriteACP", "traits": { - "smithy.api#documentation": "Allows grantee to write the ACL for the applicable\n object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Allows grantee to write the ACL for the applicable object.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, @@ -20594,21 +20594,21 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
", + "smithy.api#documentation": "By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
", "smithy.api#httpHeader": "x-amz-storage-class" } }, "WebsiteRedirectLocation": { "target": "com.amazonaws.s3#WebsiteRedirectLocation", "traits": { - "smithy.api#documentation": "If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.
", + "smithy.api#documentation": "If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata. This value is unique to each object and is not copied when using the\n x-amz-metadata-directive header. Instead, you may opt to provide this\n header in combination with the directive.
Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for\n an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For\n information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI,\n see Specifying the\n Signature Version in Request Authentication in the Amazon S3 User Guide.
", + "smithy.api#documentation": "Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests\n for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For\n information about configuring using any of the officially supported Amazon Web Services SDKs and Amazon Web Services\n CLI, see Specifying the\n Signature Version in Request Authentication in the\n Amazon S3 User Guide.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "SSEKMSEncryptionContext": { "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.
", + "smithy.api#documentation": "Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of\n this header is a base64-encoded UTF-8 string holding JSON with the encryption context\n key-value pairs.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, @@ -20651,7 +20651,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.
", + "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using AWS KMS (SSE-KMS). Setting this header to true\n causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with a COPY action doesn’t affect bucket-level settings for S3\n Bucket Key.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -20735,7 +20735,7 @@ "ETag": { "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.
" + "smithy.api#documentation": "Returns the ETag of the new object. The ETag reflects only changes to the contents of an\n object, not its metadata.
" } }, "LastModified": { @@ -20870,7 +20870,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.
\nNot every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming rules.
\nIf you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
\nBy default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.
\nIf you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.
\n Access control lists (ACLs)\n
\nWhen creating a bucket using this operation, you can optionally configure the bucket ACL to specify the accounts or\n groups that should be granted specific permissions on the bucket.
\nIf your CreateBucket request sets bucket owner enforced for S3 Object Ownership and\n specifies a bucket ACL that provides access to an external Amazon Web Services account, your request\n fails with a 400 error and returns the\n InvalidBucketAclWithObjectOwnership error code. For more information,\n see Controlling object\n ownership in the Amazon S3 User Guide.
There are two ways to grant the appropriate permissions using the request headers.
\nSpecify a canned ACL using the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each\n canned ACL has a predefined set of grantees and permissions. For more information,\n see Canned ACL.
Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list\n (ACL) overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor 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:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.
\n\n Permissions\n
\nIn addition to s3:CreateBucket, the following permissions are required when your CreateBucket includes specific headers:
\n ACLs - If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, \n authenticated-read, or if you specify access permissions explicitly through any other ACL, both \n s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the \n CreateBucket request is private or doesn't specify any ACLs, only s3:CreateBucket permission is needed.
\n Object Lock - If\n ObjectLockEnabledForBucket is set to true in your\n CreateBucket request,\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are required.
\n S3 Object Ownership - If your CreateBucket\n request includes the the x-amz-object-ownership header,\n s3:PutBucketOwnershipControls permission is required.
The following operations are related to CreateBucket:
\n PutObject\n
\n\n DeleteBucket\n
\nCreates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.
\nNot every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming\n rules.
\nIf you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
\nBy default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.
\nIf you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of\n buckets.
When creating a bucket using this operation, you can optionally configure the bucket ACL\n to specify the accounts or groups that should be granted specific permissions on the\n bucket.
\nIf your CreateBucket request sets bucket owner enforced for S3 Object Ownership and\n specifies a bucket ACL that provides access to an external Amazon Web Services account, your request\n fails with a 400 error and returns the\n InvalidBucketAclWithObjectOwnership error code. For more information,\n see Controlling object\n ownership in the Amazon S3 User Guide.
There are two ways to grant the appropriate permissions using the request\n headers.
\nSpecify a canned ACL using the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each\n canned ACL has a predefined set of grantees and permissions. For more information,\n see Canned ACL.
Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list (ACL)\n overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an\n Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor 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:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.
\nIn addition to s3:CreateBucket, the following permissions are required when\n your CreateBucket includes specific headers:
\n ACLs - If your CreateBucket request\n specifies ACL permissions and the ACL is public-read, public-read-write,\n authenticated-read, or if you specify access permissions explicitly through any other\n ACL, both s3:CreateBucket and s3:PutBucketAcl permissions\n are needed. If the ACL the CreateBucket request is private or doesn't\n specify any ACLs, only s3:CreateBucket permission is needed.
\n Object Lock - If\n ObjectLockEnabledForBucket is set to true in your\n CreateBucket request,\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are required.
\n S3 Object Ownership - If your CreateBucket\n request includes the x-amz-object-ownership header,\n s3:PutBucketOwnershipControls permission is required.
The following operations are related to CreateBucket:
\n PutObject\n
\n\n DeleteBucket\n
\nAllows grantee to create new objects in the bucket.
\nFor the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
", + "smithy.api#documentation": "Allows grantee to create new objects in the bucket.
\nFor the bucket and object owners of existing objects, also allows deletions and\n overwrites of those objects.
", "smithy.api#httpHeader": "x-amz-grant-write" } }, @@ -21004,7 +21004,7 @@ "target": "com.amazonaws.s3#CreateMultipartUploadOutput" }, "traits": { - "smithy.api#documentation": "This action initiates a multipart upload and returns an upload ID. This upload ID is\n used to associate all of the parts in the specific multipart upload. You specify this\n upload ID in each of your subsequent upload part requests (see UploadPart). You also include this\n upload ID in the final request to either complete or abort the multipart upload\n request.
\nFor more information about multipart uploads, see Multipart Upload Overview.
\nIf you have configured a lifecycle rule to abort incomplete multipart uploads, the\n upload must complete within the number of days specified in the bucket lifecycle\n configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort\n action and Amazon S3 aborts the multipart upload. For more information, see Aborting\n Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
\nFor information about the permissions required to use the multipart upload API, see\n Multipart Upload and\n Permissions.
\nFor request signing, multipart upload is just a series of regular requests. You initiate\n a multipart upload, send one or more requests to upload parts, and then complete the\n multipart upload process. You sign each request individually. There is nothing special\n about signing multipart upload requests. For more information about signing, see Authenticating\n Requests (Amazon Web Services Signature Version 4).
\nAfter you initiate a multipart upload and upload one or more parts, to stop being\n charged for storing the uploaded parts, you must either complete or abort the multipart\n upload. Amazon S3 frees up the space used to store the parts and stop charging you for\n storing them only after you either complete or abort a multipart upload.
\nYou can optionally request server-side encryption. For server-side encryption, Amazon S3\n encrypts your data as it writes it to disks in its data centers and decrypts it when you\n 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\n your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to\n initiate the upload by using CreateMultipartUpload.
To perform a multipart upload with encryption using an Amazon Web Services KMS key, the requester must\n have permission to the kms:Decrypt and kms:GenerateDataKey*\n actions on the key. These permissions are required because Amazon S3 must decrypt and read data\n from the encrypted file parts before it completes the multipart upload. For more\n information, see Multipart upload API\n 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\n as the KMS key, then you must have these permissions on the key policy. If your IAM\n user or role belongs to a different account than the key, then you must have the\n permissions on both the key policy and your IAM user or role.
\nFor more information, see Protecting\n Data Using Server-Side Encryption.
\nWhen copying an object, you can optionally specify the accounts or groups that\n should be granted specific permissions on the new object. There are two ways to\n grant the permissions using the request headers:
\nSpecify a canned ACL with the x-amz-acl request header. For\n more information, see Canned ACL.
Specify access permissions explicitly with the\n x-amz-grant-read, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. These parameters map to\n the set of permissions that Amazon S3 supports in an ACL. For more information,\n see Access Control List (ACL)\n Overview.
You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.
\nYou can optionally tell Amazon S3 to encrypt data at rest using server-side\n encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts\n your data as it writes it to disks in its data centers and decrypts it when you\n access it. The option you use depends on whether you want to use Amazon Web Services managed\n encryption keys or provide your own encryption key.
\nUse encryption keys managed by Amazon S3 or customer managed key stored\n in Amazon Web Services Key Management Service (Amazon Web Services KMS) – If you want Amazon Web Services to manage the keys\n used to encrypt data, specify the following headers in the request.
\n\n x-amz-server-side-encryption\n
\n x-amz-server-side-encryption-aws-kms-key-id\n
\n x-amz-server-side-encryption-context\n
If you specify x-amz-server-side-encryption:aws:kms, but\n don't provide x-amz-server-side-encryption-aws-kms-key-id,\n 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\n you don't make them with SSL or by using SigV4.
\nFor more information about server-side encryption with KMS key (SSE-KMS),\n see Protecting Data Using Server-Side Encryption with KMS keys.
\nUse customer-provided encryption keys – If you want to manage your own\n encryption keys, provide all the following headers in the request.
\n\n x-amz-server-side-encryption-customer-algorithm\n
\n x-amz-server-side-encryption-customer-key\n
\n x-amz-server-side-encryption-customer-key-MD5\n
For more information about server-side encryption with KMS keys (SSE-KMS),\n see Protecting Data Using Server-Side Encryption with KMS keys.
\nYou also can use the following access control–related headers with this\n operation. By default, all objects are private. Only the owner has full access\n 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\n to the access control list (ACL) on the object. For more information, see Using ACLs. With this\n operation, you can grant access permissions using one of the following two\n methods:
\nSpecify a canned ACL (x-amz-acl) — Amazon S3 supports a set of\n predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. For more information, see\n Canned\n ACL.
Specify access permissions explicitly — To explicitly grant access\n permissions to specific Amazon Web Services accounts or groups, use the following headers.\n Each header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access\n Control List (ACL) Overview. In the header, you specify a list of\n grantees who get the specific permission. To grant permissions explicitly,\n use:
\n\n x-amz-grant-read\n
\n x-amz-grant-write\n
\n x-amz-grant-read-acp\n
\n x-amz-grant-write-acp\n
\n x-amz-grant-full-control\n
You specify each grantee as a type=value pair, where the type is one of\n the following:
\n\n id – if the value specified is the canonical user ID\n of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email\n address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor 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:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n
The following operations are related to CreateMultipartUpload:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThis action initiates a multipart upload and returns an upload ID. This upload ID is\n used to associate all of the parts in the specific multipart upload. You specify this\n upload ID in each of your subsequent upload part requests (see UploadPart). You also include this\n upload ID in the final request to either complete or abort the multipart upload\n request.
\nFor more information about multipart uploads, see Multipart Upload Overview.
\nIf you have configured a lifecycle rule to abort incomplete multipart uploads, the\n upload must complete within the number of days specified in the bucket lifecycle\n configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort\n action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
\nFor information about the permissions required to use the multipart upload API, see\n Multipart\n Upload and Permissions.
\nFor request signing, multipart upload is just a series of regular requests. You initiate\n a multipart upload, send one or more requests to upload parts, and then complete the\n multipart upload process. You sign each request individually. There is nothing special\n about signing multipart upload requests. For more information about signing, see Authenticating Requests (Amazon Web Services Signature Version 4).
\nAfter you initiate a multipart upload and upload one or more parts, to stop being\n charged for storing the uploaded parts, you must either complete or abort the multipart\n upload. Amazon S3 frees up the space used to store the parts and stop charging you for\n storing them only after you either complete or abort a multipart upload.
\nServer-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it when you access it. Amazon S3\n automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a\n multipart upload, if you don't specify encryption information in your request, the\n encryption setting of the uploaded parts is set to the default encryption configuration of\n the destination bucket. By default, all buckets have a base level of encryption\n configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the\n destination bucket has a default encryption configuration that uses server-side encryption\n with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C),\n Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded\n parts. When you perform a CreateMultipartUpload operation, if you want to use a different\n type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the\n object with a KMS key, an Amazon S3 managed key, or a customer-provided key. If the encryption\n setting in your request is different from the default encryption configuration of the\n destination bucket, the encryption setting in your request takes precedence. If you choose\n to provide your own encryption key, the request headers you provide in UploadPart\n and UploadPartCopy requests must match the headers you used in the request to\n initiate the upload by using CreateMultipartUpload. You can request that Amazon S3\n save the uploaded parts encrypted with server-side encryption with an Amazon S3 managed key\n (SSE-S3), an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key\n (SSE-C).
To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester\n must have permission to the kms:Decrypt and kms:GenerateDataKey*\n actions on the key. These permissions are required because Amazon S3 must decrypt and read data\n from the encrypted file parts before it completes the multipart upload. For more\n information, see Multipart upload API\n and permissions and Protecting data using\n server-side encryption with Amazon Web Services KMS in the\n 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,\n then you must have these permissions on the key policy. If your IAM user or role belongs\n to a different account than the key, then you must have the permissions on both the key\n policy and your IAM user or role.
\nFor more information, see Protecting Data Using Server-Side\n Encryption.
\nWhen copying an object, you can optionally specify the accounts or groups that\n should be granted specific permissions on the new object. There are two ways to\n grant the permissions using the request headers:
\nSpecify a canned ACL with the x-amz-acl request header. For\n more information, see Canned\n ACL.
Specify access permissions explicitly with the\n x-amz-grant-read, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. These parameters map to\n the set of permissions that Amazon S3 supports in an ACL. For more information,\n see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.
\nAmazon S3 encrypts data\n by using server-side encryption with an Amazon S3 managed key (SSE-S3) by default. Server-side encryption is for data encryption at rest. Amazon S3 encrypts\n your data as it writes it to disks in its data centers and decrypts it when you\n access it. You can request that Amazon S3 encrypts\n data at rest by using server-side encryption with other key options. The option you use depends on\n whether you want to use KMS keys (SSE-KMS) or provide your own encryption keys\n (SSE-C).
\nUse KMS keys (SSE-KMS) that include the Amazon Web Services managed key\n (aws/s3) and KMS customer managed keys stored in Key Management Service (KMS) – If you\n want Amazon Web Services to manage the keys used to encrypt data, specify the following\n headers in the request.
\n x-amz-server-side-encryption\n
\n x-amz-server-side-encryption-aws-kms-key-id\n
\n x-amz-server-side-encryption-context\n
If you specify x-amz-server-side-encryption:aws:kms, but\n don't provide x-amz-server-side-encryption-aws-kms-key-id,\n Amazon S3 uses the Amazon Web Services managed key (aws/s3 key) in KMS to\n protect the data.
All GET and PUT requests for an object protected\n by KMS fail if you don't make them by using Secure Sockets Layer (SSL),\n Transport Layer Security (TLS), or Signature Version 4.
For more information about server-side encryption with KMS keys\n (SSE-KMS), see Protecting Data\n Using Server-Side Encryption with KMS keys.
\nUse customer-provided encryption keys (SSE-C) – If you want to manage\n your own encryption keys, provide all the following headers in the\n request.
\n\n x-amz-server-side-encryption-customer-algorithm\n
\n x-amz-server-side-encryption-customer-key\n
\n x-amz-server-side-encryption-customer-key-MD5\n
For more information about server-side encryption with customer-provided\n encryption keys (SSE-C), see \n Protecting data using server-side encryption with customer-provided\n encryption keys (SSE-C).
\nYou also can use the following access control–related headers with this\n operation. By default, all objects are private. Only the owner has full access\n control. When adding a new object, you can grant permissions to individual\n Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then\n added to the access control list (ACL) on the object. For more information, see\n Using ACLs. With this operation, you can grant access permissions\n using one of the following two methods:
\nSpecify a canned ACL (x-amz-acl) — Amazon S3 supports a set of\n predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. For more information, see\n Canned\n ACL.
Specify access permissions explicitly — To explicitly grant access\n permissions to specific Amazon Web Services accounts or groups, use the following headers.\n Each header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access Control List (ACL)\n Overview. In the header, you specify a list of grantees who get\n the specific permission. To grant permissions explicitly, use:
\n\n x-amz-grant-read\n
\n x-amz-grant-write\n
\n x-amz-grant-read-acp\n
\n x-amz-grant-write-acp\n
\n x-amz-grant-full-control\n
You specify each grantee as a type=value pair, where the type is one of\n the following:
\n\n id – if the value specified is the canonical user ID\n of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email\n address of an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor 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:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n
The following operations are related to CreateMultipartUpload:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nIf the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, the response includes this header. The header indicates when the initiated\n multipart upload becomes eligible for an abort operation. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
\nThe response also includes the x-amz-abort-rule-id header that provides the\n ID of the lifecycle configuration rule that defines this action.
If the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, the response includes this header. The header indicates when the initiated\n multipart upload becomes eligible for an abort operation. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
\nThe response also includes the x-amz-abort-rule-id header that provides the\n ID of the lifecycle configuration rule that defines this action.
The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The name of the bucket to which the multipart upload was initiated. Does not return the\n access point ARN or access point alias if used.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed key that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -21087,7 +21087,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Amazon Web Services KMS (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -21123,7 +21123,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The name of the bucket to which to initiate the upload
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The name of the bucket to which to initiate the upload
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-full-control" } }, "GrantRead": { "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "Allows grantee to read the object data and its\n metadata.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Allows grantee to read the object data and its metadata.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-read" } }, @@ -21197,7 +21197,7 @@ "GrantWriteACP": { "target": "com.amazonaws.s3#GrantWriteACP", "traits": { - "smithy.api#documentation": "Allows grantee to write the ACL for the applicable\n object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Allows grantee to write the ACL for the applicable object.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, @@ -21219,14 +21219,14 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
", + "smithy.api#documentation": "By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
", "smithy.api#httpHeader": "x-amz-storage-class" } }, @@ -21261,14 +21261,14 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "Specifies the ID of the symmetric customer managed key to use for object\n encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not\n made via SSL or using SigV4. For information about configuring using any of the officially\n supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication\n in the Amazon S3 User Guide.
", + "smithy.api#documentation": "Specifies the ID of the symmetric encryption customer managed key to use for object encryption.\n All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL\n or using SigV4. For information about configuring using any of the officially supported\n Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication\n in the Amazon S3 User Guide.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "SSEKMSEncryptionContext": { "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.
", + "smithy.api#documentation": "Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of\n this header is a base64-encoded UTF-8 string holding JSON with the encryption context\n key-value pairs.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, @@ -21276,7 +21276,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
", + "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using AWS KMS (SSE-KMS). Setting this header to true\n causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3\n Bucket Key.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -21379,7 +21379,7 @@ } }, "traits": { - "smithy.api#documentation": "The container element for specifying the default Object Lock retention settings for new\n objects placed in the specified bucket.
\nThe DefaultRetention settings require both a mode and a\n period.
The DefaultRetention period can be either Days\n or Years but you must select one. You cannot specify Days\n and Years at the same time.
The container element for specifying the default Object Lock retention settings for new\n objects placed in the specified bucket.
\nThe DefaultRetention settings require both a mode and a\n period.
The DefaultRetention period can be either Days or\n Years but you must select one. You cannot specify\n Days and Years at the same time.
Deletes the S3 bucket. All objects (including all object versions and delete markers) in\n the bucket must be deleted before the bucket itself can be deleted.
\n\n Related Resources\n
\n\n CreateBucket\n
\n\n DeleteObject\n
\nDeletes the S3 bucket. All objects (including all object versions and delete markers) in\n the bucket must be deleted before the bucket itself can be deleted.
\nThe following operations are related to DeleteBucket:
\n CreateBucket\n
\n\n DeleteObject\n
\nDeletes an analytics configuration for the bucket (specified by the analytics\n configuration ID).
\nTo use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.
\nThe following operations are related to\n DeleteBucketAnalyticsConfiguration:
Deletes an analytics configuration for the bucket (specified by the analytics\n configuration ID).
\nTo use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.
\nThe following operations are related to\n DeleteBucketAnalyticsConfiguration:
Deletes the cors configuration information set for the bucket.
To use this operation, you must have permission to perform the\n s3:PutBucketCORS action. The bucket owner has this permission by default\n and can grant this permission to others.
For information about cors, see Enabling\n Cross-Origin Resource Sharing in the Amazon S3 User Guide.
\n Related Resources:\n
\n\n PutBucketCors\n
\n\n RESTOPTIONSobject\n
\nDeletes the cors configuration information set for the bucket.
To use this operation, you must have permission to perform the\n s3:PutBucketCORS action. The bucket owner has this permission by default\n and can grant this permission to others.
For information about cors, see Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.
The following operations are related to DeleteBucketCors:
\n PutBucketCors\n
\n\n RESTOPTIONSobject\n
\nThis implementation of the DELETE action removes default encryption from the bucket.\n For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the\n Amazon S3 User Guide.
\nTo use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3\n Resources in the Amazon S3 User Guide.
\n Related Resources\n
\n\n PutBucketEncryption\n
\n\n GetBucketEncryption\n
\nThis implementation of the DELETE action resets the default encryption for the\n bucket as server-side encryption with Amazon S3 managed keys (SSE-S3). For information about the\n bucket default encryption feature, see Amazon S3 Bucket Default Encryption\n in the Amazon S3 User Guide.
\nTo use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to your Amazon S3 Resources in the\n Amazon S3 User Guide.
The following operations are related to DeleteBucketEncryption:
\n PutBucketEncryption\n
\n\n GetBucketEncryption\n
\nDeletes the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe 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 three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
\nThe 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 monitored and 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n DeleteBucketIntelligentTieringConfiguration include:
Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe 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 three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
\nThe 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 monitored and 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to DeleteBucketIntelligentTieringConfiguration include:
Deletes an inventory configuration (identified by the inventory ID) from the\n bucket.
\nTo use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
\nOperations related to DeleteBucketInventoryConfiguration include:
Deletes an inventory configuration (identified by the inventory ID) from the\n bucket.
\nTo use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
\nOperations related to DeleteBucketInventoryConfiguration include:
Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the\n lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your\n objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of\n rules contained in the deleted lifecycle configuration.
\nTo use this operation, you must have permission to perform the\n s3:PutLifecycleConfiguration action. By default, the bucket owner has this\n permission and the bucket owner can grant this permission to others.
There is usually some time lag before lifecycle configuration deletion is fully\n propagated to all the Amazon S3 systems.
\nFor more information about the object expiration, see Elements to\n Describe Lifecycle Actions.
\nRelated actions include:
\nDeletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the\n lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your\n objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of\n rules contained in the deleted lifecycle configuration.
\nTo use this operation, you must have permission to perform the\n s3:PutLifecycleConfiguration action. By default, the bucket owner has this\n permission and the bucket owner can grant this permission to others.
There is usually some time lag before lifecycle configuration deletion is fully\n propagated to all the Amazon S3 systems.
\nFor more information about the object expiration, see Elements to Describe Lifecycle Actions.
\nRelated actions include:
\nDeletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the\n metrics configuration ID) from the bucket. Note that this doesn't include the daily storage\n metrics.
\n To use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
\nThe following operations are related to\n DeleteBucketMetricsConfiguration:
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the\n metrics configuration ID) from the bucket. Note that this doesn't include the daily storage\n metrics.
\n To use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with\n Amazon CloudWatch.
\nThe following operations are related to\n DeleteBucketMetricsConfiguration:
The ID used to identify the metrics configuration.
", + "smithy.api#documentation": "The ID used to identify the metrics configuration. The ID has a 64 character limit and\n can only contain letters, numbers, periods, dashes, and underscores.
", "smithy.api#httpQuery": "id", "smithy.api#required": {} } @@ -21758,7 +21758,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you\n must have the s3:PutBucketOwnershipControls permission. For more information\n about Amazon S3 permissions, see Specifying\n Permissions in a Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
\nThe following operations are related to\n DeleteBucketOwnershipControls:
Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you\n must have the s3:PutBucketOwnershipControls permission. For more information\n about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
\nThe following operations are related to\n DeleteBucketOwnershipControls:
This implementation of the DELETE action uses the policy subresource to delete the\n policy of a specified bucket. If you are using an identity other than the root user of the\n Amazon Web Services account that owns the bucket, the calling identity must have the\n DeleteBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account to use this operation.
If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and\n UserPolicies.
\nThe following operations are related to DeleteBucketPolicy\n
\n CreateBucket\n
\n\n DeleteObject\n
\nThis implementation of the DELETE action uses the policy subresource to delete the\n policy of a specified bucket. If you are using an identity other than the root user of the\n Amazon Web Services account that owns the bucket, the calling identity must have the\n DeleteBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account to use this operation.
If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.
To ensure that bucket owners don't inadvertently lock themselves out of their own\n buckets, the root principal in a bucket owner's Amazon Web Services account can perform the\n GetBucketPolicy, PutBucketPolicy, and\n DeleteBucketPolicy API actions, even if their bucket policy explicitly\n denies the root principal's access. Bucket owner root principals can only be blocked from performing \n these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
For more information about bucket policies, see Using Bucket Policies and\n UserPolicies.
\nThe following operations are related to DeleteBucketPolicy\n
\n CreateBucket\n
\n\n DeleteObject\n
\nDeletes the replication configuration from the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:PutReplicationConfiguration action. The bucket owner has these\n permissions by default and can grant it to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
It can take a while for the deletion of a replication configuration to fully\n propagate.
\nFor information about replication configuration, see Replication in the Amazon S3 User Guide.
\nThe following operations are related to DeleteBucketReplication:
\n PutBucketReplication\n
\n\n GetBucketReplication\n
\nDeletes the replication configuration from the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:PutReplicationConfiguration action. The bucket owner has these\n permissions by default and can grant it to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
It can take a while for the deletion of a replication configuration to fully\n propagate.
\nFor information about replication configuration, see Replication in the\n Amazon S3 User Guide.
\nThe following operations are related to DeleteBucketReplication:
\n PutBucketReplication\n
\n\n GetBucketReplication\n
\nRemoves the null version (if there is one) of an object and inserts a delete marker,\n which becomes the latest version of the object. If there isn't a null version, Amazon S3 does\n not remove any objects but will still respond that the command was successful.
\nTo remove a specific version, you must be the bucket owner and you must use the version\n Id subresource. Using this subresource permanently deletes the version. If the object\n deleted is a delete marker, Amazon S3 sets the response header,\n x-amz-delete-marker, to true.
If the object you want to delete is in a bucket where the bucket versioning\n configuration is MFA Delete enabled, you must include the x-amz-mfa request\n header in the DELETE versionId request. Requests that include\n x-amz-mfa must use HTTPS.
For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.
\nYou can delete objects by explicitly calling DELETE Object or configure its\n lifecycle (PutBucketLifecycle) to\n enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or\n deleting objects from your bucket, you must deny them the s3:DeleteObject,\n s3:DeleteObjectVersion, and s3:PutLifeCycleConfiguration\n actions.
The following action is related to DeleteObject:
\n PutObject\n
\nRemoves the null version (if there is one) of an object and inserts a delete marker,\n which becomes the latest version of the object. If there isn't a null version, Amazon S3 does\n not remove any objects but will still respond that the command was successful.
\nTo remove a specific version, you must use the version Id subresource. Using this\n subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3\n sets the response header, x-amz-delete-marker, to true.
If the object you want to delete is in a bucket where the bucket versioning\n configuration is MFA Delete enabled, you must include the x-amz-mfa request\n header in the DELETE versionId request. Requests that include\n x-amz-mfa must use HTTPS.
For more information about MFA Delete, see Using MFA Delete. To see sample\n requests that use versioning, see Sample\n Request.
\nYou can delete objects by explicitly calling DELETE Object or configure its lifecycle\n (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block\n users or accounts from removing or deleting objects from your bucket, you must deny them\n the s3:DeleteObject, s3:DeleteObjectVersion, and\n s3:PutLifeCycleConfiguration actions.
The following action is related to DeleteObject:
\n PutObject\n
\nThe bucket name of the bucket containing the object.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The bucket name of the bucket containing the object.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process\n this operation. To use this header, you must have the s3:BypassGovernanceRetention\n permission.
Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process\n this operation. To use this header, you must have the\n s3:BypassGovernanceRetention permission.
Removes the entire tag set from the specified object. For more information about\n managing object tags, see Object\n Tagging.
\nTo use this operation, you must have permission to perform the\n s3:DeleteObjectTagging action.
To delete tags of a specific object version, add the versionId query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging action.
The following operations are related to\n DeleteBucketMetricsConfiguration:
\n PutObjectTagging\n
\n\n GetObjectTagging\n
\nRemoves the entire tag set from the specified object. For more information about\n managing object tags, see Object Tagging.
\nTo use this operation, you must have permission to perform the\n s3:DeleteObjectTagging action.
To delete tags of a specific object version, add the versionId query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging action.
The following operations are related to DeleteObjectTagging:
\n PutObjectTagging\n
\n\n GetObjectTagging\n
\nThe bucket name containing the objects from which to remove the tags.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The bucket name containing the objects from which to remove the tags.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
This action enables you to delete multiple objects from a bucket using a single HTTP\n request. If you know the object keys that you want to delete, then this action provides\n a suitable alternative to sending individual delete requests, reducing per-request\n overhead.
\nThe request contains a list of up to 1000 keys that you want to delete. In the XML, you\n provide the object key names, and optionally, version IDs if you want to delete a specific\n version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a\n delete action and returns the result of that delete, success, or failure, in the\n response. Note that if the object specified in the request is not found, Amazon S3 returns the\n result as deleted.
\nThe action supports two modes for the response: verbose and quiet. By default, the\n action uses verbose mode in which the response includes the result of deletion of each\n key in your request. In quiet mode the response includes only keys where the delete\n action encountered an error. For a successful deletion, the action does not return\n any information about the delete in the response body.
\nWhen performing this action on an MFA Delete enabled bucket, that attempts to delete\n any versioned objects, you must include an MFA token. If you do not provide one, the entire\n request will fail, even if there are non-versioned objects you are trying to delete. If you\n provide an invalid token, whether there are versioned keys in the request or not, the\n entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA\n Delete.
\nFinally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon\n S3 uses the header value to ensure that your request body has not been altered in\n transit.
\nThe following operations are related to DeleteObjects:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nThis action enables you to delete multiple objects from a bucket using a single HTTP\n request. If you know the object keys that you want to delete, then this action provides a\n suitable alternative to sending individual delete requests, reducing per-request\n overhead.
\nThe request contains a list of up to 1000 keys that you want to delete. In the XML, you\n provide the object key names, and optionally, version IDs if you want to delete a specific\n version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a\n delete action and returns the result of that delete, success, or failure, in the response.\n Note that if the object specified in the request is not found, Amazon S3 returns the result as\n deleted.
\nThe action supports two modes for the response: verbose and quiet. By default, the\n action uses verbose mode in which the response includes the result of deletion of each key\n in your request. In quiet mode the response includes only keys where the delete action\n encountered an error. For a successful deletion, the action does not return any information\n about the delete in the response body.
\nWhen performing this action on an MFA Delete enabled bucket, that attempts to delete any\n versioned objects, you must include an MFA token. If you do not provide one, the entire\n request will fail, even if there are non-versioned objects you are trying to delete. If you\n provide an invalid token, whether there are versioned keys in the request or not, the\n entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA\n Delete.
\nFinally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in\n transit.
\nThe following operations are related to DeleteObjects:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nThe bucket name containing the objects to delete.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The bucket name containing the objects to delete.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Specifies whether you want to delete this object even if it has a Governance-type Object\n Lock in place. To use this header, you must have the s3:BypassGovernanceRetention\n permission.
Specifies whether you want to delete this object even if it has a Governance-type Object\n Lock in place. To use this header, you must have the\n s3:BypassGovernanceRetention permission.
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any\n additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.
This checksum algorithm must be the same for all parts and it match the checksum\n value supplied in the CreateMultipartUpload request.
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any\n additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.
This checksum algorithm must be the same for all parts and it match the checksum value\n supplied in the CreateMultipartUpload request.
Removes the PublicAccessBlock configuration for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketPublicAccessBlock permission. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
The following operations are related to DeletePublicAccessBlock:
\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nRemoves the PublicAccessBlock configuration for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketPublicAccessBlock permission. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
The following operations are related to DeletePublicAccessBlock:
\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nThe Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the\n results.
", "smithy.api#required": {} } }, "Account": { "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to\n change replica ownership to the Amazon Web Services account that owns the destination bucket by specifying\n the AccessControlTranslation property, this is the account ID of the\n destination bucket owner. For more information, see Replication Additional\n Configuration: Changing the Replica Owner in the Amazon S3 User Guide.
Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to\n change replica ownership to the Amazon Web Services account that owns the destination bucket by\n specifying the AccessControlTranslation property, this is the account ID of\n the destination bucket owner. For more information, see Replication Additional\n Configuration: Changing the Replica Owner in the\n Amazon S3 User Guide.
Specify this only in a cross-account scenario (where source and destination bucket\n owners are not the same), and you want to change replica ownership to the Amazon Web Services account that\n owns the destination bucket. If this is not specified in the replication configuration, the\n replicas are owned by same Amazon Web Services account that owns the source object.
" + "smithy.api#documentation": "Specify this only in a cross-account scenario (where source and destination bucket\n owners are not the same), and you want to change replica ownership to the Amazon Web Services account\n that owns the destination bucket. If this is not specified in the replication\n configuration, the replicas are owned by same Amazon Web Services account that owns the source\n object.
" } }, "EncryptionConfiguration": { @@ -22544,14 +22544,14 @@ "EncryptionType": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing job results in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#documentation": "The server-side encryption algorithm used when storing job results in Amazon S3 (for example,\n AES256, aws:kms).
If the encryption type is aws:kms, this optional value specifies the ID of\n the symmetric customer managed key to use for encryption of job results. Amazon S3 only\n supports symmetric keys. For more information, see Using symmetric and\n asymmetric keys in the Amazon Web Services Key Management Service Developer\n Guide.
If the encryption type is aws:kms, this optional value specifies the ID of\n the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only\n supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service\n Developer Guide.
Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key\n stored in Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses\n this key to encrypt replica objects. Amazon S3 only supports symmetric, customer managed KMS keys.\n For more information, see Using symmetric and\n asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.
" + "smithy.api#documentation": "Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key stored in\n Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to\n encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more\n information, see Asymmetric keys in Amazon Web Services\n KMS in the Amazon Web Services Key Management Service Developer\n Guide.
" } } }, @@ -22610,7 +22610,7 @@ "Code": { "target": "com.amazonaws.s3#Code", "traits": { - "smithy.api#documentation": "The error code is a string that uniquely identifies an error condition. It is meant to\n be read and understood by programs that detect and handle errors by type.
\n\n Amazon S3 error codes\n
\n\n Code: AccessDenied
\n\n Description: Access Denied
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AccountProblem
\n\n Description: There is a problem with your Amazon Web Services account\n that prevents the action from completing successfully. Contact Amazon Web Services Support\n for further assistance.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AllAccessDisabled
\n\n Description: All access to this Amazon S3 resource has been\n disabled. Contact Amazon Web Services Support for further assistance.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AmbiguousGrantByEmailAddress
\n\n Description: The email address you provided is\n associated with more than one account.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AuthorizationHeaderMalformed
\n\n Description: The authorization header you provided is\n invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n HTTP Status Code: N/A
\n\n Code: BadDigest
\n\n Description: The Content-MD5 you specified did not\n match what we received.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: BucketAlreadyExists
\n\n Description: The requested bucket name is not\n available. The bucket namespace is shared by all users of the system. Please\n select a different name and try again.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: BucketAlreadyOwnedByYou
\n\n Description: The bucket you tried to create already\n exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in\n the North Virginia Region. For legacy compatibility, if you re-create an\n existing bucket that you already own in the North Virginia Region, Amazon S3 returns\n 200 OK and resets the bucket access control lists (ACLs).
\n\n Code: 409 Conflict (in all Regions except the North\n Virginia Region)
\n\n SOAP Fault Code Prefix: Client
\n\n Code: BucketNotEmpty
\n\n Description: The bucket you tried to delete is not\n empty.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: CredentialsNotSupported
\n\n Description: This request does not support\n credentials.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: CrossLocationLoggingProhibited
\n\n Description: Cross-location logging not allowed.\n Buckets in one geographic location cannot log information to a bucket in\n another location.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: EntityTooSmall
\n\n Description: Your proposed upload is smaller than the\n minimum allowed object size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: EntityTooLarge
\n\n Description: Your proposed upload exceeds the maximum\n allowed object size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: ExpiredToken
\n\n Description: The provided token has expired.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: IllegalVersioningConfigurationException
\n\n Description: Indicates that the versioning\n configuration specified in the request is invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: IncompleteBody
\n\n Description: You did not provide the number of bytes\n specified by the Content-Length HTTP header
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: IncorrectNumberOfFilesInPostRequest
\n\n Description: POST requires exactly one file upload per\n request.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InlineDataTooLarge
\n\n Description: Inline data exceeds the maximum allowed\n size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InternalError
\n\n Description: We encountered an internal error. Please\n try again.
\n\n HTTP Status Code: 500 Internal Server Error
\n\n SOAP Fault Code Prefix: Server
\n\n Code: InvalidAccessKeyId
\n\n Description: The Amazon Web Services access key ID you provided does\n not exist in our records.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidAddressingHeader
\n\n Description: You must specify the Anonymous\n role.
\n\n HTTP Status Code: N/A
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidArgument
\n\n Description: Invalid Argument
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidBucketName
\n\n Description: The specified bucket is not valid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidBucketState
\n\n Description: The request is not valid with the current\n state of the bucket.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidDigest
\n\n Description: The Content-MD5 you specified is not\n valid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidEncryptionAlgorithmError
\n\n Description: The encryption request you specified is\n not valid. The valid value is AES256.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidLocationConstraint
\n\n Description: The specified location constraint is not\n valid. For more information about Regions, see How to Select a\n Region for Your Buckets.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidObjectState
\n\n Description: The action is not valid for the current\n state of the object.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPart
\n\n Description: One or more of the specified parts could\n not be found. The part might not have been uploaded, or the specified entity\n tag might not have matched the part's entity tag.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPartOrder
\n\n Description: The list of parts was not in ascending\n order. Parts list must be specified in order by part number.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPayer
\n\n Description: All access to this object has been\n disabled. Please contact Amazon Web Services Support for further assistance.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPolicyDocument
\n\n Description: The content of the form does not meet the\n conditions specified in the policy document.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidRange
\n\n Description: The requested range cannot be\n satisfied.
\n\n HTTP Status Code: 416 Requested Range Not\n Satisfiable
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidRequest
\n\n Description: Please use AWS4-HMAC-SHA256.
\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: SOAP requests must be made over an HTTPS\n connection.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration is not\n supported for buckets with non-DNS compliant names.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration is not\n supported for buckets with periods (.) in their names.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Accelerate endpoint only\n supports virtual style requests.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Accelerate is not configured\n on this bucket.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Accelerate is disabled on\n this bucket.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration is not\n supported on this bucket. Contact Amazon Web Services Support for more information.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration cannot be\n enabled on this bucket. Contact Amazon Web Services Support for more information.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidSecurity
\n\n Description: The provided security credentials are not\n valid.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidSOAPRequest
\n\n Description: The SOAP request body is invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidStorageClass
\n\n Description: The storage class you specified is not\n valid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidTargetBucketForLogging
\n\n Description: The target bucket for logging does not\n exist, is not owned by you, or does not have the appropriate grants for the\n log-delivery group.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidToken
\n\n Description: The provided token is malformed or\n otherwise invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidURI
\n\n Description: Couldn't parse the specified URI.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: KeyTooLongError
\n\n Description: Your key is too long.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MalformedACLError
\n\n Description: The XML you provided was not well-formed\n or did not validate against our published schema.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MalformedPOSTRequest
\n\n Description: The body of your POST request is not\n well-formed multipart/form-data.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MalformedXML
\n\n Description: This happens when the user sends malformed\n XML (XML that doesn't conform to the published XSD) for the configuration. The\n error message is, \"The XML you provided was not well-formed or did not validate\n against our published schema.\"
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MaxMessageLengthExceeded
\n\n Description: Your request was too big.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MaxPostPreDataLengthExceededError
\n\n Description: Your POST request fields preceding the\n upload file were too large.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MetadataTooLarge
\n\n Description: Your metadata headers exceed the maximum\n allowed metadata size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MethodNotAllowed
\n\n Description: The specified method is not allowed\n against this resource.
\n\n HTTP Status Code: 405 Method Not Allowed
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingAttachment
\n\n Description: A SOAP attachment was expected, but none\n were found.
\n\n HTTP Status Code: N/A
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingContentLength
\n\n Description: You must provide the Content-Length HTTP\n header.
\n\n HTTP Status Code: 411 Length Required
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingRequestBodyError
\n\n Description: This happens when the user sends an empty\n XML document as a request. The error message is, \"Request body is empty.\"\n
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingSecurityElement
\n\n Description: The SOAP 1.1 request is missing a security\n element.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingSecurityHeader
\n\n Description: Your request is missing a required\n header.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoLoggingStatusForKey
\n\n Description: There is no such thing as a logging status\n subresource for a key.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchBucket
\n\n Description: The specified bucket does not\n exist.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchBucketPolicy
\n\n Description: The specified bucket does not have a\n bucket policy.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchKey
\n\n Description: The specified key does not exist.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchLifecycleConfiguration
\n\n Description: The lifecycle configuration does not\n exist.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchUpload
\n\n Description: The specified multipart upload does not\n exist. The upload ID might be invalid, or the multipart upload might have been\n aborted or completed.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchVersion
\n\n Description: Indicates that the version ID specified in\n the request does not match an existing version.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NotImplemented
\n\n Description: A header you provided implies\n functionality that is not implemented.
\n\n HTTP Status Code: 501 Not Implemented
\n\n SOAP Fault Code Prefix: Server
\n\n Code: NotSignedUp
\n\n Description: Your account is not signed up for the Amazon S3\n service. You must sign up before you can use Amazon S3. You can sign up at the\n following URL: Amazon S3\n
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: OperationAborted
\n\n Description: A conflicting conditional action is\n currently in progress against this resource. Try again.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: PermanentRedirect
\n\n Description: The bucket you are attempting to access\n must be addressed using the specified endpoint. Send all future requests to\n this endpoint.
\n\n HTTP Status Code: 301 Moved Permanently
\n\n SOAP Fault Code Prefix: Client
\n\n Code: PreconditionFailed
\n\n Description: At least one of the preconditions you\n specified did not hold.
\n\n HTTP Status Code: 412 Precondition Failed
\n\n SOAP Fault Code Prefix: Client
\n\n Code: Redirect
\n\n Description: Temporary redirect.
\n\n HTTP Status Code: 307 Moved Temporarily
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RestoreAlreadyInProgress
\n\n Description: Object restore is already in\n progress.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestIsNotMultiPartContent
\n\n Description: Bucket POST must be of the enclosure-type\n multipart/form-data.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestTimeout
\n\n Description: Your socket connection to the server was\n not read from or written to within the timeout period.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestTimeTooSkewed
\n\n Description: The difference between the request time\n and the server's time is too large.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestTorrentOfBucketError
\n\n Description: Requesting the torrent file of a bucket is\n not permitted.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: SignatureDoesNotMatch
\n\n Description: The request signature we calculated does\n not match the signature you provided. Check your Amazon Web Services secret access key and\n signing method. For more information, see REST Authentication and\n SOAP Authentication\n for details.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: ServiceUnavailable
\n\n Description: Reduce your request rate.
\n\n HTTP Status Code: 503 Service Unavailable
\n\n SOAP Fault Code Prefix: Server
\n\n Code: SlowDown
\n\n Description: Reduce your request rate.
\n\n HTTP Status Code: 503 Slow Down
\n\n SOAP Fault Code Prefix: Server
\n\n Code: TemporaryRedirect
\n\n Description: You are being redirected to the bucket\n while DNS updates.
\n\n HTTP Status Code: 307 Moved Temporarily
\n\n SOAP Fault Code Prefix: Client
\n\n Code: TokenRefreshRequired
\n\n Description: The provided token must be\n refreshed.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: TooManyBuckets
\n\n Description: You have attempted to create more buckets\n than allowed.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: UnexpectedContent
\n\n Description: This request does not support\n content.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: UnresolvableGrantByEmailAddress
\n\n Description: The email address you provided does not\n match any account on record.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: UserKeyMustBeSpecified
\n\n Description: The bucket POST must contain the specified\n field name. If it is specified, check the order of the fields.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\nThe error code is a string that uniquely identifies an error condition. It is meant to\n be read and understood by programs that detect and handle errors by type. The following is\n a list of Amazon S3 error codes. For more information, see Error responses.
\n\n Code: AccessDenied
\n\n Description: Access Denied
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AccountProblem
\n\n Description: There is a problem with your Amazon Web Services account\n that prevents the action from completing successfully. Contact Amazon Web Services Support\n for further assistance.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AllAccessDisabled
\n\n Description: All access to this Amazon S3 resource has been\n disabled. Contact Amazon Web Services Support for further assistance.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AmbiguousGrantByEmailAddress
\n\n Description: The email address you provided is\n associated with more than one account.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AuthorizationHeaderMalformed
\n\n Description: The authorization header you provided is\n invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n HTTP Status Code: N/A
\n\n Code: BadDigest
\n\n Description: The Content-MD5 you specified did not\n match what we received.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: BucketAlreadyExists
\n\n Description: The requested bucket name is not\n available. The bucket namespace is shared by all users of the system. Please\n select a different name and try again.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: BucketAlreadyOwnedByYou
\n\n Description: The bucket you tried to create already\n exists, and you own it. Amazon S3 returns this error in all Amazon Web Services Regions except in\n the North Virginia Region. For legacy compatibility, if you re-create an\n existing bucket that you already own in the North Virginia Region, Amazon S3 returns\n 200 OK and resets the bucket access control lists (ACLs).
\n\n Code: 409 Conflict (in all Regions except the North\n Virginia Region)
\n\n SOAP Fault Code Prefix: Client
\n\n Code: BucketNotEmpty
\n\n Description: The bucket you tried to delete is not\n empty.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: CredentialsNotSupported
\n\n Description: This request does not support\n credentials.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: CrossLocationLoggingProhibited
\n\n Description: Cross-location logging not allowed.\n Buckets in one geographic location cannot log information to a bucket in\n another location.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: EntityTooSmall
\n\n Description: Your proposed upload is smaller than the\n minimum allowed object size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: EntityTooLarge
\n\n Description: Your proposed upload exceeds the maximum\n allowed object size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: ExpiredToken
\n\n Description: The provided token has expired.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: IllegalVersioningConfigurationException
\n\n Description: Indicates that the versioning\n configuration specified in the request is invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: IncompleteBody
\n\n Description: You did not provide the number of bytes\n specified by the Content-Length HTTP header
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: IncorrectNumberOfFilesInPostRequest
\n\n Description: POST requires exactly one file upload per\n request.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InlineDataTooLarge
\n\n Description: Inline data exceeds the maximum allowed\n size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InternalError
\n\n Description: We encountered an internal error. Please\n try again.
\n\n HTTP Status Code: 500 Internal Server Error
\n\n SOAP Fault Code Prefix: Server
\n\n Code: InvalidAccessKeyId
\n\n Description: The Amazon Web Services access key ID you provided does\n not exist in our records.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidAddressingHeader
\n\n Description: You must specify the Anonymous\n role.
\n\n HTTP Status Code: N/A
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidArgument
\n\n Description: Invalid Argument
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidBucketName
\n\n Description: The specified bucket is not valid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidBucketState
\n\n Description: The request is not valid with the current\n state of the bucket.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidDigest
\n\n Description: The Content-MD5 you specified is not\n valid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidEncryptionAlgorithmError
\n\n Description: The encryption request you specified is\n not valid. The valid value is AES256.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidLocationConstraint
\n\n Description: The specified location constraint is not\n valid. For more information about Regions, see How to Select\n a Region for Your Buckets.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidObjectState
\n\n Description: The action is not valid for the current\n state of the object.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPart
\n\n Description: One or more of the specified parts could\n not be found. The part might not have been uploaded, or the specified entity\n tag might not have matched the part's entity tag.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPartOrder
\n\n Description: The list of parts was not in ascending\n order. Parts list must be specified in order by part number.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPayer
\n\n Description: All access to this object has been\n disabled. Please contact Amazon Web Services Support for further assistance.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPolicyDocument
\n\n Description: The content of the form does not meet the\n conditions specified in the policy document.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidRange
\n\n Description: The requested range cannot be\n satisfied.
\n\n HTTP Status Code: 416 Requested Range Not\n Satisfiable
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidRequest
\n\n Description: Please use\n AWS4-HMAC-SHA256.
\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: SOAP requests must be made over an HTTPS\n connection.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration is not\n supported for buckets with non-DNS compliant names.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration is not\n supported for buckets with periods (.) in their names.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Accelerate endpoint only\n supports virtual style requests.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Accelerate is not configured\n on this bucket.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Accelerate is disabled on\n this bucket.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration is not\n supported on this bucket. Contact Amazon Web Services Support for more information.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration cannot be\n enabled on this bucket. Contact Amazon Web Services Support for more information.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidSecurity
\n\n Description: The provided security credentials are not\n valid.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidSOAPRequest
\n\n Description: The SOAP request body is invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidStorageClass
\n\n Description: The storage class you specified is not\n valid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidTargetBucketForLogging
\n\n Description: The target bucket for logging does not\n exist, is not owned by you, or does not have the appropriate grants for the\n log-delivery group.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidToken
\n\n Description: The provided token is malformed or\n otherwise invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidURI
\n\n Description: Couldn't parse the specified URI.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: KeyTooLongError
\n\n Description: Your key is too long.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MalformedACLError
\n\n Description: The XML you provided was not well-formed\n or did not validate against our published schema.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MalformedPOSTRequest
\n\n Description: The body of your POST request is not\n well-formed multipart/form-data.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MalformedXML
\n\n Description: This happens when the user sends malformed\n XML (XML that doesn't conform to the published XSD) for the configuration. The\n error message is, \"The XML you provided was not well-formed or did not validate\n against our published schema.\"
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MaxMessageLengthExceeded
\n\n Description: Your request was too big.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MaxPostPreDataLengthExceededError
\n\n Description: Your POST request fields preceding the\n upload file were too large.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MetadataTooLarge
\n\n Description: Your metadata headers exceed the maximum\n allowed metadata size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MethodNotAllowed
\n\n Description: The specified method is not allowed\n against this resource.
\n\n HTTP Status Code: 405 Method Not Allowed
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingAttachment
\n\n Description: A SOAP attachment was expected, but none\n were found.
\n\n HTTP Status Code: N/A
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingContentLength
\n\n Description: You must provide the Content-Length HTTP\n header.
\n\n HTTP Status Code: 411 Length Required
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingRequestBodyError
\n\n Description: This happens when the user sends an empty\n XML document as a request. The error message is, \"Request body is empty.\"\n
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingSecurityElement
\n\n Description: The SOAP 1.1 request is missing a security\n element.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingSecurityHeader
\n\n Description: Your request is missing a required\n header.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoLoggingStatusForKey
\n\n Description: There is no such thing as a logging status\n subresource for a key.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchBucket
\n\n Description: The specified bucket does not\n exist.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchBucketPolicy
\n\n Description: The specified bucket does not have a\n bucket policy.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchKey
\n\n Description: The specified key does not exist.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchLifecycleConfiguration
\n\n Description: The lifecycle configuration does not\n exist.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchUpload
\n\n Description: The specified multipart upload does not\n exist. The upload ID might be invalid, or the multipart upload might have been\n aborted or completed.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchVersion
\n\n Description: Indicates that the version ID specified in\n the request does not match an existing version.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NotImplemented
\n\n Description: A header you provided implies\n functionality that is not implemented.
\n\n HTTP Status Code: 501 Not Implemented
\n\n SOAP Fault Code Prefix: Server
\n\n Code: NotSignedUp
\n\n Description: Your account is not signed up for the Amazon S3\n service. You must sign up before you can use Amazon S3. You can sign up at the\n following URL: Amazon S3\n
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: OperationAborted
\n\n Description: A conflicting conditional action is\n currently in progress against this resource. Try again.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: PermanentRedirect
\n\n Description: The bucket you are attempting to access\n must be addressed using the specified endpoint. Send all future requests to\n this endpoint.
\n\n HTTP Status Code: 301 Moved Permanently
\n\n SOAP Fault Code Prefix: Client
\n\n Code: PreconditionFailed
\n\n Description: At least one of the preconditions you\n specified did not hold.
\n\n HTTP Status Code: 412 Precondition Failed
\n\n SOAP Fault Code Prefix: Client
\n\n Code: Redirect
\n\n Description: Temporary redirect.
\n\n HTTP Status Code: 307 Moved Temporarily
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RestoreAlreadyInProgress
\n\n Description: Object restore is already in\n progress.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestIsNotMultiPartContent
\n\n Description: Bucket POST must be of the enclosure-type\n multipart/form-data.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestTimeout
\n\n Description: Your socket connection to the server was\n not read from or written to within the timeout period.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestTimeTooSkewed
\n\n Description: The difference between the request time\n and the server's time is too large.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestTorrentOfBucketError
\n\n Description: Requesting the torrent file of a bucket is\n not permitted.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: SignatureDoesNotMatch
\n\n Description: The request signature we calculated does\n not match the signature you provided. Check your Amazon Web Services secret access key and\n signing method. For more information, see REST\n Authentication and SOAP\n Authentication for details.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: ServiceUnavailable
\n\n Description: Service is unable to handle\n request.
\n\n HTTP Status Code: 503 Service Unavailable
\n\n SOAP Fault Code Prefix: Server
\n\n Code: SlowDown
\n\n Description: Reduce your request rate.
\n\n HTTP Status Code: 503 Slow Down
\n\n SOAP Fault Code Prefix: Server
\n\n Code: TemporaryRedirect
\n\n Description: You are being redirected to the bucket\n while DNS updates.
\n\n HTTP Status Code: 307 Moved Temporarily
\n\n SOAP Fault Code Prefix: Client
\n\n Code: TokenRefreshRequired
\n\n Description: The provided token must be\n refreshed.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: TooManyBuckets
\n\n Description: You have attempted to create more buckets\n than allowed.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: UnexpectedContent
\n\n Description: This request does not support\n content.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: UnresolvableGrantByEmailAddress
\n\n Description: The email address you provided does not\n match any account on record.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: UserKeyMustBeSpecified
\n\n Description: The bucket POST must contain the specified\n field name. If it is specified, check the order of the fields.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\nSpecifies whether Amazon S3 replicates existing source bucket objects.
", "smithy.api#required": {} } } @@ -23008,7 +23008,7 @@ "target": "com.amazonaws.s3#GetBucketAccelerateConfigurationOutput" }, "traits": { - "smithy.api#documentation": "This implementation of the GET action uses the accelerate subresource to\n return the Transfer Acceleration state of a bucket, which is either Enabled or\n Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that\n enables you to perform faster data transfers to and from Amazon S3.
To use this operation, you must have permission to perform the\n s3:GetAccelerateConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3\n Resources in the Amazon S3 User Guide.
You set the Transfer Acceleration state of an existing bucket to Enabled or\n Suspended by using the PutBucketAccelerateConfiguration operation.
A GET accelerate request does not return a state value for a bucket that\n has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state\n has never been set on the bucket.
For more information about transfer acceleration, see Transfer Acceleration in the\n Amazon S3 User Guide.
\n\n Related Resources\n
\nThis implementation of the GET action uses the accelerate subresource to\n return the Transfer Acceleration state of a bucket, which is either Enabled or\n Suspended. Amazon S3 Transfer Acceleration is a bucket-level feature that\n enables you to perform faster data transfers to and from Amazon S3.
To use this operation, you must have permission to perform the\n s3:GetAccelerateConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to your Amazon S3 Resources in the\n Amazon S3 User Guide.
You set the Transfer Acceleration state of an existing bucket to Enabled or\n Suspended by using the PutBucketAccelerateConfiguration operation.
A GET accelerate request does not return a state value for a bucket that\n has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state\n has never been set on the bucket.
For more information about transfer acceleration, see Transfer Acceleration in\n the Amazon S3 User Guide.
\nThe following operations are related to GetBucketAccelerateConfiguration:
This implementation of the GET action uses the acl\n subresource to return the access control list (ACL) of a bucket. To use GET to\n return the ACL of the bucket, you must have READ_ACP access to the bucket. If\n READ_ACP permission is granted to the anonymous user, you can return the\n ACL of the bucket without using an authorization header.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership, \n requests to read ACLs are still supported and return the bucket-owner-full-control \n ACL with the owner being the account that created the bucket. For more information, see \n \n Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.
\n Related Resources\n
\n\n ListObjects\n
\nThis implementation of the GET action uses the acl subresource\n to return the access control list (ACL) of a bucket. To use GET to return the\n ACL of the bucket, you must have READ_ACP access to the bucket. If\n READ_ACP permission is granted to the anonymous user, you can return the\n ACL of the bucket without using an authorization header.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
If your bucket uses the bucket owner enforced setting for S3 Object Ownership,\n requests to read ACLs are still supported and return the\n bucket-owner-full-control ACL with the owner being the account that\n created the bucket. For more information, see Controlling object\n ownership and disabling ACLs in the\n Amazon S3 User Guide.
The following operations are related to GetBucketAcl:
\n ListObjects\n
\nSpecifies the S3 bucket whose ACL is being requested.
", + "smithy.api#documentation": "Specifies the S3 bucket whose ACL is being requested.
\nTo use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
This implementation of the GET action returns an analytics configuration (identified\n by the analytics configuration ID) from the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon S3 User Guide.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis in the Amazon S3 User Guide.
\n\n Related Resources\n
\nThis implementation of the GET action returns an analytics configuration (identified by\n the analytics configuration ID) from the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis in the Amazon S3 User Guide.
\nThe following operations are related to GetBucketAnalyticsConfiguration:
Returns the Cross-Origin Resource Sharing (CORS) configuration information set for the\n bucket.
\n To use this operation, you must have permission to perform the\n s3:GetBucketCORS action. By default, the bucket owner has this permission\n and can grant it to others.
For more information about CORS, see Enabling Cross-Origin Resource\n Sharing.
\nThe following operations are related to GetBucketCors:
\n PutBucketCors\n
\n\n DeleteBucketCors\n
\nReturns the Cross-Origin Resource Sharing (CORS) configuration information set for the\n bucket.
\n To use this operation, you must have permission to perform the\n s3:GetBucketCORS action. By default, the bucket owner has this permission\n and can grant it to others.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
For more information about CORS, see Enabling Cross-Origin Resource\n Sharing.
\nThe following operations are related to GetBucketCors:
\n PutBucketCors\n
\n\n DeleteBucketCors\n
\nThe bucket name for which to get the cors configuration.
", + "smithy.api#documentation": "The bucket name for which to get the cors configuration.
\nTo use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not\n have a default encryption configuration, GetBucketEncryption returns\n ServerSideEncryptionConfigurationNotFoundError.
For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.
\n To use this operation, you must have permission to perform the\n s3:GetEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
The following operations are related to GetBucketEncryption:
\n PutBucketEncryption\n
\nReturns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that\n uses server-side encryption with Amazon S3 managed keys (SSE-S3). For information\n about the bucket default encryption feature, see Amazon S3 Bucket\n Default Encryption in the Amazon S3 User Guide.
\nTo use this operation, you must have permission to perform the\n s3:GetEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
The following operations are related to GetBucketEncryption:
\n PutBucketEncryption\n
\nGets the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe 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 three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
\nThe 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 monitored and 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n GetBucketIntelligentTieringConfiguration include:
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe 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 three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
\nThe 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 monitored and 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to GetBucketIntelligentTieringConfiguration include:
Returns an inventory configuration (identified by the inventory configuration ID) from\n the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
\nThe following operations are related to\n GetBucketInventoryConfiguration:
Returns an inventory configuration (identified by the inventory configuration ID) from\n the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
\nThe following operations are related to\n GetBucketInventoryConfiguration:
Bucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The response describes the new filter element\n that you can use to specify a filter to select a subset of objects to which the rule\n applies. If you are using a previous version of the lifecycle configuration, it still\n works. For the earlier action, see GetBucketLifecycle.
\nReturns the lifecycle configuration information set on the bucket. For information about\n lifecycle configuration, see Object\n Lifecycle Management.
\nTo use this operation, you must have permission to perform the\n s3:GetLifecycleConfiguration action. The bucket owner has this permission,\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
\n GetBucketLifecycleConfiguration has the following special error:
Error code: NoSuchLifecycleConfiguration\n
Description: The lifecycle configuration does not exist.
\nHTTP Status Code: 404 Not Found
\nSOAP Fault Code Prefix: Client
\nThe following operations are related to\n GetBucketLifecycleConfiguration:
\n GetBucketLifecycle\n
\n\n PutBucketLifecycle\n
\nBucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The response describes the new filter element\n that you can use to specify a filter to select a subset of objects to which the rule\n applies. If you are using a previous version of the lifecycle configuration, it still\n works. For the earlier action, see GetBucketLifecycle.
\nReturns the lifecycle configuration information set on the bucket. For information about\n lifecycle configuration, see Object Lifecycle\n Management.
\nTo use this operation, you must have permission to perform the\n s3:GetLifecycleConfiguration action. The bucket owner has this permission,\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
\n GetBucketLifecycleConfiguration has the following special error:
Error code: NoSuchLifecycleConfiguration\n
Description: The lifecycle configuration does not exist.
\nHTTP Status Code: 404 Not Found
\nSOAP Fault Code Prefix: Client
\nThe following operations are related to\n GetBucketLifecycleConfiguration:
\n GetBucketLifecycle\n
\n\n PutBucketLifecycle\n
\nReturns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint request parameter in a CreateBucket\n request. For more information, see CreateBucket.
To use this implementation of the operation, you must be the bucket owner.
\nTo use this API against an access point, provide the alias of the access point in place of the bucket name.
\nThe following operations are related to GetBucketLocation:
\n GetObject\n
\n\n CreateBucket\n
\nReturns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint request parameter in a CreateBucket\n request. For more information, see CreateBucket.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
We recommend that you use HeadBucket to return the Region\n that a bucket resides in. For backward compatibility, Amazon S3 continues to support\n GetBucketLocation.
\nThe following operations are related to GetBucketLocation:
\n GetObject\n
\n\n CreateBucket\n
\nSpecifies the Region where the bucket resides. For a list of all the Amazon S3 supported\n location constraints by Region, see Regions and Endpoints.\n Buckets in Region us-east-1 have a LocationConstraint of\n null.
Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported\n location constraints by Region, see Regions and Endpoints. Buckets in\n Region us-east-1 have a LocationConstraint of null.
The name of the bucket for which to get the location.
", + "smithy.api#documentation": "The name of the bucket for which to get the location.
\nTo use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
Returns the logging status of a bucket and the permissions users have to view and modify\n that status. To use GET, you must be the bucket owner.
\nThe following operations are related to GetBucketLogging:
\n CreateBucket\n
\n\n PutBucketLogging\n
\nReturns the logging status of a bucket and the permissions users have to view and modify\n that status.
\nThe following operations are related to GetBucketLogging:
\n CreateBucket\n
\n\n PutBucketLogging\n
\nGets a metrics configuration (specified by the metrics configuration ID) from the\n bucket. Note that this doesn't include the daily storage metrics.
\n To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon\n CloudWatch.
\nThe following operations are related to\n GetBucketMetricsConfiguration:
Gets a metrics configuration (specified by the metrics configuration ID) from the\n bucket. Note that this doesn't include the daily storage metrics.
\n To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring\n Metrics with Amazon CloudWatch.
\nThe following operations are related to\n GetBucketMetricsConfiguration:
The ID used to identify the metrics configuration.
", + "smithy.api#documentation": "The ID used to identify the metrics configuration. The ID has a 64 character limit and\n can only contain letters, numbers, periods, dashes, and underscores.
", "smithy.api#httpQuery": "id", "smithy.api#required": {} } @@ -23679,7 +23679,7 @@ "target": "com.amazonaws.s3#NotificationConfiguration" }, "traits": { - "smithy.api#documentation": "Returns the notification configuration of a bucket.
\nIf notifications are not enabled on the bucket, the action returns an empty\n NotificationConfiguration element.
By default, you must be the bucket owner to read the notification configuration of a\n bucket. However, the bucket owner can use a bucket policy to grant permission to other\n users to read this configuration with the s3:GetBucketNotification\n permission.
For more information about setting and reading the notification configuration on a\n bucket, see Setting Up Notification of\n Bucket Events. For more information about bucket policies, see Using Bucket Policies.
\nThe following action is related to GetBucketNotification:
Returns the notification configuration of a bucket.
\nIf notifications are not enabled on the bucket, the action returns an empty\n NotificationConfiguration element.
By default, you must be the bucket owner to read the notification configuration of a\n bucket. However, the bucket owner can use a bucket policy to grant permission to other\n users to read this configuration with the s3:GetBucketNotification\n permission.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
For more information about setting and reading the notification configuration on a\n bucket, see Setting Up Notification of Bucket Events. For more information about bucket\n policies, see Using Bucket Policies.
\nThe following action is related to GetBucketNotification:
The name of the bucket for which to get the notification configuration.
", + "smithy.api#documentation": "The name of the bucket for which to get the notification configuration.
\nTo use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you\n must have the s3:GetBucketOwnershipControls permission. For more information\n about Amazon S3 permissions, see Specifying\n permissions in a policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
\nThe following operations are related to GetBucketOwnershipControls:
Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you\n must have the s3:GetBucketOwnershipControls permission. For more information\n about Amazon S3 permissions, see Specifying permissions in a\n policy.
For information about Amazon S3 Object Ownership, see Using Object\n Ownership.
\nThe following operations are related to GetBucketOwnershipControls:
The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in\n effect for this Amazon S3 bucket.
The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or\n ObjectWriter) currently in effect for this Amazon S3 bucket.
Returns the policy of a specified bucket. If you are using an identity other than the\n root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n GetBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User\n Policies.
\nThe following action is related to GetBucketPolicy:
\n GetObject\n
\nReturns the policy of a specified bucket. If you are using an identity other than the\n root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n GetBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.
To ensure that bucket owners don't inadvertently lock themselves out of their own\n buckets, the root principal in a bucket owner's Amazon Web Services account can perform the\n GetBucketPolicy, PutBucketPolicy, and\n DeleteBucketPolicy API actions, even if their bucket policy explicitly\n denies the root principal's access. Bucket owner root principals can only be blocked from performing \n these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
To use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
For more information about bucket policies, see Using Bucket Policies and User\n Policies.
\nThe following action is related to GetBucketPolicy:
\n GetObject\n
\nThe bucket name for which to get the bucket policy.
", + "smithy.api#documentation": "The bucket name for which to get the bucket policy.
\nTo use this API operation against an access point, provide the alias of the access point in place of the bucket name.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.\n In order to use this operation, you must have the s3:GetBucketPolicyStatus\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".
\nThe following operations are related to GetBucketPolicyStatus:
\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nRetrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.\n In order to use this operation, you must have the s3:GetBucketPolicyStatus\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".
\nThe following operations are related to GetBucketPolicyStatus:
\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nReturns the request payment configuration of a bucket. To use this version of the\n operation, you must be the bucket owner. For more information, see Requester Pays Buckets.
\nThe following operations are related to GetBucketRequestPayment:
\n ListObjects\n
\nReturns the request payment configuration of a bucket. To use this version of the\n operation, you must be the bucket owner. For more information, see Requester Pays\n Buckets.
\nThe following operations are related to GetBucketRequestPayment:
\n ListObjects\n
\nReturns the website configuration for a bucket. To host website on Amazon S3, you can\n configure a bucket as website by adding a website configuration. For more information about\n hosting websites, see Hosting Websites on\n Amazon S3.
\nThis GET action requires the S3:GetBucketWebsite permission. By default,\n only the bucket owner can read the bucket website configuration. However, bucket owners can\n allow other users to read the website configuration by writing a bucket policy granting\n them the S3:GetBucketWebsite permission.
The following operations are related to DeleteBucketWebsite:
\n DeleteBucketWebsite\n
\n\n PutBucketWebsite\n
\nReturns the website configuration for a bucket. To host website on Amazon S3, you can\n configure a bucket as website by adding a website configuration. For more information about\n hosting websites, see Hosting Websites on Amazon S3.
\nThis GET action requires the S3:GetBucketWebsite permission. By default,\n only the bucket owner can read the bucket website configuration. However, bucket owners can\n allow other users to read the website configuration by writing a bucket policy granting\n them the S3:GetBucketWebsite permission.
The following operations are related to GetBucketWebsite:
\n DeleteBucketWebsite\n
\n\n PutBucketWebsite\n
\nRetrieves objects from Amazon S3. To use GET, you must have READ\n access to the object. If you grant READ access to the anonymous user, you can\n 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\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg,\n 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\n in the GET operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg, specify the resource as\n /photos/2006/February/sample.jpg. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg in the bucket named\n examplebucket, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host Header Bucket Specification.
For more information about returning the ACL of an object, see GetObjectAcl.
\nIf the object you are retrieving is stored in the S3 Glacier or\n S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this action returns an\n InvalidObjectStateError error. For information about restoring archived\n objects, see Restoring Archived\n Objects.
Encryption request headers, like x-amz-server-side-encryption, should not\n be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS) \n or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your\n 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\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).
\nAssuming you have the relevant permission to read object tags, the response also returns the\n x-amz-tagging-count header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.
\n Permissions\n
\nYou need the relevant read object (or version) permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3 will\n return an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket permission, Amazon S3 will return an\n HTTP status code 403 (\"access denied\") error.
\n Versioning\n
\nBy default, the GET action returns the current version of an object. To return a\n different version, use the versionId subresource.
\n If you supply a versionId, you need the s3:GetObjectVersion permission to\n access a specific version of an object. If you request a specific version, you do not need to have\n the s3:GetObject permission.\n
If the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true in the\n response.
For more information about versioning, see PutBucketVersioning.
\n\n Overriding Response Header Values\n
\nThere are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response\n header value in your GET request.
You can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type,\n Content-Language, Expires, Cache-Control,\n Content-Disposition, and Content-Encoding. To override these\n 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,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.
\n\n response-content-type\n
\n response-content-language\n
\n response-expires\n
\n response-cache-control\n
\n response-content-disposition\n
\n response-content-encoding\n
\n Additional Considerations about Request Headers\n
\nIf both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
\nThe following operations are related to GetObject:
\n ListBuckets\n
\n\n GetObjectAcl\n
\nRetrieves objects from Amazon S3. To use GET, you must have READ\n access to the object. If you grant READ access to the anonymous user, you can\n 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\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg,\n 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\n in the GET operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg, specify the resource as\n /photos/2006/February/sample.jpg. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg in the bucket named\n examplebucket, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg. For more information about\n request types, see HTTP Host\n Header Bucket Specification.
For more information about returning the ACL of an object, see GetObjectAcl.
\nIf the object you are retrieving is stored in the S3 Glacier or\n S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a\n copy using RestoreObject. Otherwise, this action returns an\n InvalidObjectState error. For information about restoring archived objects,\n see Restoring\n Archived Objects.
Encryption request headers, like x-amz-server-side-encryption, should not\n be sent for GET requests if your object uses server-side encryption with KMS keys\n (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your\n 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\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys).
\nAssuming you have the relevant permission to read object tags, the response also returns\n the x-amz-tagging-count header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.
You need the relevant read object (or version) permission for this operation. For more\n information, see Specifying Permissions in a\n Policy. If the object you request does not exist, the error Amazon S3 returns depends\n on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3 will\n return an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket permission, Amazon S3 will return an\n HTTP status code 403 (\"access denied\") error.
By default, the GET action returns the current version of an object. To return a\n different version, use the versionId subresource.
If you supply a versionId, you need the\n s3:GetObjectVersion permission to access a specific version of an\n object. If you request a specific version, you do not need to have the\n s3:GetObject permission. If you request the current version\n without a specific version ID, only s3:GetObject permission is\n required. s3:GetObjectVersion permission won't be required.
If the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true in the\n response.
For more information about versioning, see PutBucketVersioning.
\nThere are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response\n header value in your GET request.
You can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type,\n Content-Language, Expires, Cache-Control,\n Content-Disposition, and Content-Encoding. To override these\n 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,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.
\n\n response-content-type\n
\n response-content-language\n
\n response-expires\n
\n response-cache-control\n
\n response-content-disposition\n
\n response-content-encoding\n
If both of the If-Match and If-Unmodified-Since headers are\n present in the request as follows: If-Match condition evaluates to\n true, and; If-Unmodified-Since condition evaluates to\n false; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match and If-Modified-Since headers are\n present in the request as follows: If-None-Match condition evaluates to\n false, and; If-Modified-Since condition evaluates to\n true; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
\nThe following operations are related to GetObject:
\n ListBuckets\n
\n\n GetObjectAcl\n
\nReturns the access control list (ACL) of an object. To use this operation, you must have\n s3:GetObjectAcl permissions or READ_ACP access to the object.\n For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3\n User Guide\n
This action is not supported by Amazon S3 on Outposts.
\n\n Versioning\n
\nBy default, GET returns ACL information about the current version of an object. To\n return ACL information about a different version, use the versionId subresource.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, \n requests to read ACLs are still supported and return the bucket-owner-full-control \n ACL with the owner being the account that created the bucket. For more information, see \n \n Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.
The following operations are related to GetObjectAcl:
\n GetObject\n
\n\n GetObjectAttributes\n
\n\n DeleteObject\n
\n\n PutObject\n
\nReturns the access control list (ACL) of an object. To use this operation, you must have\n s3:GetObjectAcl permissions or READ_ACP access to the object.\n For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3\n User Guide\n
This action is not supported by Amazon S3 on Outposts.
\nBy default, GET returns ACL information about the current version of an object. To\n return ACL information about a different version, use the versionId subresource.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership,\n requests to read ACLs are still supported and return the\n bucket-owner-full-control ACL with the owner being the account that\n created the bucket. For more information, see Controlling object\n ownership and disabling ACLs in the\n Amazon S3 User Guide.
The following operations are related to GetObjectAcl:
\n GetObject\n
\n\n GetObjectAttributes\n
\n\n DeleteObject\n
\n\n PutObject\n
\nRetrieves all the metadata from an object without returning the object itself. This\n action is useful if you're interested only in an object's metadata. To use\n GetObjectAttributes, you must have READ access to the object.
\n GetObjectAttributes combines the functionality of\n GetObjectAcl, GetObjectLegalHold,\n GetObjectLockConfiguration, GetObjectRetention,\n GetObjectTagging, HeadObject, and ListParts. All\n of the data returned with each of those individual calls can be returned with a single call\n to GetObjectAttributes.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:
\n\n x-amz-server-side-encryption-customer-algorithm\n
\n x-amz-server-side-encryption-customer-key\n
\n x-amz-server-side-encryption-customer-key-MD5\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\nEncryption request headers, such as\n x-amz-server-side-encryption, should not be sent for GET requests\n if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web Services Key\n Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed\n encryption keys (SSE-S3). If your object does use these types of keys, you'll get\n an HTTP 400 Bad Request error.
\n The last modified property in this case is the creation date of the object.
\nConsider the following when using request headers:
\n If both of the If-Match and If-Unmodified-Since\n headers are present in the request as follows, then Amazon S3 returns the HTTP\n status code 200 OK and the data requested:
\n If-Match condition evaluates to true.
\n If-Unmodified-Since condition evaluates to\n false.
If both of the If-None-Match and If-Modified-Since\n headers are present in the request as follows, then Amazon S3 returns the HTTP status code\n 304 Not Modified:
\n If-None-Match condition evaluates to\n false.
\n If-Modified-Since condition evaluates to\n true.
For more information about conditional requests, see RFC 7232.
\n\n Permissions\n
\nThe permissions that you need to use this operation depend on whether the bucket is\n versioned. If the bucket is versioned, you need both the s3:GetObjectVersion\n and s3:GetObjectVersionAttributes permissions for this operation. If the\n bucket is not versioned, you need the s3:GetObject and\n s3:GetObjectAttributes permissions. For more information, see Specifying\n Permissions in a Policy in the Amazon S3 User Guide. If the\n object that you request does not exist, the error Amazon S3 returns depends on whether you also\n have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3\n returns an HTTP status code 404 Not Found (\"no such key\") error.
If you don't have the s3:ListBucket permission, Amazon S3 returns an\n HTTP status code 403 Forbidden (\"access denied\") error.
The following actions are related to GetObjectAttributes:
\n GetObject\n
\n\n GetObjectAcl\n
\n\n GetObjectLegalHold\n
\n\n GetObjectRetention\n
\n\n GetObjectTagging\n
\n\n HeadObject\n
\n\n ListParts\n
\nRetrieves all the metadata from an object without returning the object itself. This\n action is useful if you're interested only in an object's metadata. To use\n GetObjectAttributes, you must have READ access to the object.
\n GetObjectAttributes combines the functionality of HeadObject\n and ListParts. All of the data returned with each of those individual calls\n can be returned with a single call to GetObjectAttributes.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:
\n\n x-amz-server-side-encryption-customer-algorithm\n
\n x-amz-server-side-encryption-customer-key\n
\n x-amz-server-side-encryption-customer-key-MD5\n
For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\nEncryption request headers, such as x-amz-server-side-encryption,\n should not be sent for GET requests if your object uses server-side encryption\n with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or\n server-side encryption with Amazon S3 managed keys (SSE-S3). If your object does use\n these types of keys, you'll get an HTTP 400 Bad Request error.
The last modified property in this case is the creation date of the\n object.
\nConsider the following when using request headers:
\n If both of the If-Match and If-Unmodified-Since headers\n are present in the request as follows, then Amazon S3 returns the HTTP status code\n 200 OK and the data requested:
\n If-Match condition evaluates to true.
\n If-Unmodified-Since condition evaluates to\n false.
If both of the If-None-Match and If-Modified-Since\n headers are present in the request as follows, then Amazon S3 returns the HTTP status code\n 304 Not Modified:
\n If-None-Match condition evaluates to false.
\n If-Modified-Since condition evaluates to\n true.
For more information about conditional requests, see RFC 7232.
\nThe permissions that you need to use this operation depend on whether the bucket is\n versioned. If the bucket is versioned, you need both the s3:GetObjectVersion\n and s3:GetObjectVersionAttributes permissions for this operation. If the\n bucket is not versioned, you need the s3:GetObject and\n s3:GetObjectAttributes permissions. For more information, see Specifying\n Permissions in a Policy in the Amazon S3 User Guide. If the\n object that you request does not exist, the error Amazon S3 returns depends on whether you also\n have the s3:ListBucket permission.
If you have the s3:ListBucket permission on the bucket, Amazon S3 returns\n an HTTP status code 404 Not Found (\"no such key\") error.
If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP\n status code 403 Forbidden (\"access denied\") error.
The following actions are related to GetObjectAttributes:
\n GetObject\n
\n\n GetObjectAcl\n
\n\n GetObjectLegalHold\n
\n\n GetObjectRetention\n
\n\n GetObjectTagging\n
\n\n HeadObject\n
\n\n ListParts\n
\nAn ETag is an opaque identifier assigned by a web server to a specific version of a\n resource found at a URL.
" + "smithy.api#documentation": "An ETag is an opaque identifier assigned by a web server to a specific version of a\n resource found at a URL.
" } }, "Checksum": { @@ -24407,7 +24407,7 @@ "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "Provides the storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\nFor more information, see Storage\n Classes.
" + "smithy.api#documentation": "Provides the storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\nFor more information, see Storage Classes.
" } }, "ObjectSize": { @@ -24456,7 +24456,7 @@ "target": "com.amazonaws.s3#IsTruncated", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the returned list of parts is truncated. A value of\n true indicates that the list was truncated. A list can be truncated if the\n number of parts exceeds the limit returned in the MaxParts element.
Indicates whether the returned list of parts is truncated. A value of true\n indicates that the list was truncated. A list can be truncated if the number of parts\n exceeds the limit returned in the MaxParts element.
The name of the bucket that contains the object.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The name of the bucket that contains the object.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Specifies the part after which listing should begin. Only parts with higher part numbers\n will be listed.
", + "smithy.api#documentation": "Specifies the part after which listing should begin. Only parts with higher part numbers\n will be listed.
", "smithy.api#httpHeader": "x-amz-part-number-marker" } }, "SSECustomerAlgorithm": { "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "Specifies the algorithm to use when encrypting the object (for example,\n AES256).
", + "smithy.api#documentation": "Specifies the algorithm to use when encrypting the object (for example, AES256).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, "SSECustomerKey": { "target": "com.amazonaws.s3#SSECustomerKey", "traits": { - "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", + "smithy.api#documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, @@ -24553,7 +24553,7 @@ "ObjectAttributes": { "target": "com.amazonaws.s3#ObjectAttributesList", "traits": { - "smithy.api#documentation": "An XML header that specifies the fields at the root level that you want returned in\n the response. Fields that you do not specify are not returned.
", + "smithy.api#documentation": "An XML header that specifies the fields at the root level that you want returned in the\n response. Fields that you do not specify are not returned.
", "smithy.api#httpHeader": "x-amz-object-attributes", "smithy.api#required": {} } @@ -24651,7 +24651,7 @@ "target": "com.amazonaws.s3#GetObjectLockConfigurationOutput" }, "traits": { - "smithy.api#documentation": "Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock\n configuration will be applied by default to every new object placed in the specified\n bucket. For more information, see Locking\n Objects.
\nThe following action is related to GetObjectLockConfiguration:
\n GetObjectAttributes\n
\nGets the Object Lock configuration for a bucket. The rule specified in the Object Lock\n configuration will be applied by default to every new object placed in the specified\n bucket. For more information, see Locking Objects.
\nThe following action is related to GetObjectLockConfiguration:
\n GetObjectAttributes\n
\nProvides information about object restoration action and expiration time of the\n restored object copy.
", + "smithy.api#documentation": "Provides information about object restoration action and expiration time of the restored\n object copy.
", "smithy.api#httpHeader": "x-amz-restore" } }, @@ -24864,7 +24864,7 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed key that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -24900,7 +24900,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services\n KMS (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -24928,7 +24928,7 @@ "target": "com.amazonaws.s3#PartsCount", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The count of parts this object has. This value is only returned if you specify partNumber\n in your request and the object was uploaded as a multipart upload.
The count of parts this object has. This value is only returned if you specify\n partNumber in your request and the object was uploaded as a multipart\n upload.
The bucket name containing the object.
\nWhen 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.
\nWhen using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The bucket name containing the object.
\nWhen 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.
\nWhen using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Downloads the specified range bytes of an object. For more information about the HTTP\n Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
\nAmazon S3 doesn't support retrieving multiple ranges of data per GET\n request.
Downloads the specified range bytes of an object. For more information about the HTTP\n Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.
\nAmazon S3 doesn't support retrieving multiple ranges of data per GET\n request.
Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This\n value is used to decrypt the object when recovering it and must match the one used when \n storing the data. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.
Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This\n value is used to decrypt the object when recovering it and must match the one used when\n storing the data. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header.
Retrieves an object's retention settings. For more information, see Locking Objects.
\nThis action is not supported by Amazon S3 on Outposts.
\nThe following action is related to GetObjectRetention:
\n GetObjectAttributes\n
\nRetrieves an object's retention settings. For more information, see Locking\n Objects.
\nThis action is not supported by Amazon S3 on Outposts.
\nThe following action is related to GetObjectRetention:
\n GetObjectAttributes\n
\nReturns the tag-set of an object. You send the GET request against the tagging\n subresource associated with the object.
\nTo use this operation, you must have permission to perform the\n s3:GetObjectTagging action. By default, the GET action returns\n information about current version of an object. For a versioned bucket, you can have\n multiple versions of an object in your bucket. To retrieve tags of any other version, use\n the versionId query parameter. You also need permission for the\n s3:GetObjectVersionTagging action.
By default, the bucket owner has this permission and can grant this permission to\n others.
\nFor information about the Amazon S3 object tagging feature, see Object Tagging.
\nThe following actions are related to GetObjectTagging:
\n DeleteObjectTagging\n
\n\n GetObjectAttributes\n
\n\n PutObjectTagging\n
\nReturns the tag-set of an object. You send the GET request against the tagging\n subresource associated with the object.
\nTo use this operation, you must have permission to perform the\n s3:GetObjectTagging action. By default, the GET action returns information\n about current version of an object. For a versioned bucket, you can have multiple versions\n of an object in your bucket. To retrieve tags of any other version, use the versionId query\n parameter. You also need permission for the s3:GetObjectVersionTagging\n action.
By default, the bucket owner has this permission and can grant this permission to\n others.
\nFor information about the Amazon S3 object tagging feature, see Object Tagging.
\nThe following actions are related to GetObjectTagging:
\n DeleteObjectTagging\n
\n\n GetObjectAttributes\n
\n\n PutObjectTagging\n
\nThe bucket name containing the object for which to get the tagging information.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The bucket name containing the object for which to get the tagging information.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're\n distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.
\nYou can get torrent only for objects that are less than 5 GB in size, and that are\n not encrypted using server-side encryption with a customer-provided encryption\n key.
\nTo use GET, you must have READ access to the object.
\nThis action is not supported by Amazon S3 on Outposts.
\nThe following action is related to GetObjectTorrent:
\n GetObject\n
\nReturns torrent files from a bucket. BitTorrent can save you bandwidth when you're\n distributing large files.
\nYou can get torrent only for objects that are less than 5 GB in size, and that are\n not encrypted using server-side encryption with a customer-provided encryption\n key.
\nTo use GET, you must have READ access to the object.
\nThis action is not supported by Amazon S3 on Outposts.
\nThe following action is related to GetObjectTorrent:
\n GetObject\n
\nRetrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use\n this operation, you must have the s3:GetBucketPublicAccessBlock permission.\n For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or\n an object, it checks the PublicAccessBlock configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock settings are different between the bucket and the\n account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
\nThe following operations are related to GetPublicAccessBlock:
\n PutPublicAccessBlock\n
\n\n GetPublicAccessBlock\n
\nRetrieves the PublicAccessBlock configuration for an Amazon S3 bucket. To use\n this operation, you must have the s3:GetBucketPublicAccessBlock permission.\n For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or\n an object, it checks the PublicAccessBlock configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock settings are different between the bucket and the\n account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
\nThe following operations are related to GetPublicAccessBlock:
\n PutPublicAccessBlock\n
\n\n GetPublicAccessBlock\n
\nThis action is useful to determine if a bucket exists and you have permission to\n access it. The action returns a 200 OK if the bucket exists and you have\n permission to access it.
If the bucket does not exist or you do not have permission to access it, the HEAD request\n returns a generic 404 Not Found or 403 Forbidden code. A message body is not \n included, so you cannot determine the exception beyond these error codes.
To use this operation, you must have permissions to perform the\n s3:ListBucket action. The bucket owner has this permission by default and\n 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\n 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.
", + "smithy.api#documentation": "This action is useful to determine if a bucket exists and you have permission to access\n it. The action returns a 200 OK if the bucket exists and you have permission\n to access it.
If the bucket does not exist or you do not have permission to access it, the\n HEAD request returns a generic 400 Bad Request, 403\n Forbidden or 404 Not Found code. A message body is not included, so\n you cannot determine the exception beyond these error codes.
To use this operation, you must have permissions to perform the\n s3:ListBucket action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
To use this API operation against an access point, you must provide the alias of the access point in place of the\n bucket name or specify the access point ARN. When using the access point ARN, you must direct requests to\n the access point hostname. The access point hostname takes the form\n AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.\n When using the Amazon Web Services SDKs, you provide the ARN in place of the bucket name. For more\n information, see Using access points.
\nTo use this API operation against an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \nIf the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \nFor more information about InvalidAccessPointAliasError, see List of\n Error Codes.
The bucket name.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The bucket name.
\nWhen 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.
\nWhen you use this action with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. \n If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. \n For more information about InvalidAccessPointAliasError, see List of\n Error Codes.
When you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
The HEAD action retrieves metadata from an object without returning the object\n itself. This action is useful if you're only interested in an object's metadata. To use\n HEAD, you must have READ access to the object.
\nA HEAD request has the same options as a GET action on an\n object. The response is identical to the GET response except that there is no\n response body. Because of this, if the HEAD request generates an error, it\n returns a generic 404 Not Found or 403 Forbidden code. It is not \n possible to retrieve the exact exception beyond these error codes.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).
\nEncryption request headers, like x-amz-server-side-encryption, should\n not be sent for GET requests if your object uses server-side encryption with KMS keys (SSE-KMS)\n or server-side encryption with Amazon S3–managed encryption keys\n (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest\n error.
\n The last modified property in this case is the creation date of the object.
\nRequest headers are limited to 8 KB in size. For more information, see Common Request\n Headers.
\nConsider the following when using request headers:
\n Consideration 1 – If both of the If-Match and\n If-Unmodified-Since headers are present in the request as\n follows:
\n If-Match condition evaluates to true, and;
\n If-Unmodified-Since condition evaluates to\n false;
Then Amazon S3 returns 200 OK and the data requested.
Consideration 2 – If both of the If-None-Match and\n If-Modified-Since headers are present in the request as\n follows:
\n If-None-Match condition evaluates to false,\n and;
\n If-Modified-Since condition evaluates to\n true;
Then Amazon S3 returns the 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
\n\n Permissions\n
\nYou need the relevant read object (or version) permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.
\nIf you have the s3:ListBucket permission on the bucket, Amazon S3 returns\n an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP\n status code 403 (\"access denied\") error.
The following actions are related to HeadObject:
\n GetObject\n
\n\n GetObjectAttributes\n
\nThe HEAD action retrieves metadata from an object without returning the object itself.\n This action is useful if you're only interested in an object's metadata. To use HEAD, you\n must have READ access to the object.
\nA HEAD request has the same options as a GET action on an\n object. The response is identical to the GET response except that there is no\n response body. Because of this, if the HEAD request generates an error, it\n returns a generic 400 Bad Request, 403 Forbidden or 404 Not\n Found code. It is not possible to retrieve the exact exception beyond these error\n codes.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys).
\nEncryption request headers, like x-amz-server-side-encryption,\n should not be sent for GET requests if your object uses server-side encryption\n with KMS keys (SSE-KMS) or server-side encryption with Amazon S3–managed encryption\n keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400\n BadRequest error.
The last modified property in this case is the creation date of the\n object.
\nRequest headers are limited to 8 KB in size. For more information, see Common\n Request Headers.
\nConsider the following when using request headers:
\n Consideration 1 – If both of the If-Match and\n If-Unmodified-Since headers are present in the request as\n follows:
\n If-Match condition evaluates to true, and;
\n If-Unmodified-Since condition evaluates to\n false;
Then Amazon S3 returns 200 OK and the data requested.
Consideration 2 – If both of the If-None-Match and\n If-Modified-Since headers are present in the request as\n follows:
\n If-None-Match condition evaluates to false,\n and;
\n If-Modified-Since condition evaluates to\n true;
Then Amazon S3 returns the 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
\nYou need the relevant read object (or version) permission for this operation. For more\n information, see Actions, resources, and condition keys for Amazon S3. \n If the object you request does not exist, the error Amazon S3 returns depends\n on whether you also have the s3:ListBucket permission.
\nIf you have the s3:ListBucket permission on the bucket, Amazon S3 returns\n an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP\n status code 403 (\"access denied\") error.
The following actions are related to HeadObject:
\n GetObject\n
\n\n GetObjectAttributes\n
\nIf the object is stored using server-side encryption either with an Amazon Web Services KMS key or \n an Amazon S3-managed encryption key, the response includes this header with\n the value of the server-side encryption algorithm used when storing this object in Amazon\n S3 (for example, AES256, aws:kms).
", + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed key that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -25861,14 +25861,14 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services\n KMS (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\nFor more information, see Storage\n Classes.
", + "smithy.api#documentation": "Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\nFor more information, see Storage Classes.
", "smithy.api#httpHeader": "x-amz-storage-class" } }, @@ -25881,7 +25881,7 @@ "ReplicationStatus": { "target": "com.amazonaws.s3#ReplicationStatus", "traits": { - "smithy.api#documentation": "Amazon S3 can return this header if your request involves a bucket that is either a source or\n a destination in a replication rule.
\nIn replication, you have a source bucket on which you configure replication and\n destination bucket or buckets where Amazon S3 stores object replicas. When you request an object\n (GetObject) or object metadata (HeadObject) from these\n buckets, Amazon S3 will return the x-amz-replication-status header in the response\n as follows:
\n If requesting an object from the source bucket, Amazon S3 will return the\n x-amz-replication-status header if the object in your request is\n eligible for replication.
For example, suppose that in your replication configuration, you specify object\n prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix\n TaxDocs. Any objects you upload with this key name prefix, for\n example TaxDocs/document1.pdf, are eligible for replication. For any\n object request with this key name prefix, Amazon S3 will return the\n x-amz-replication-status header with value PENDING, COMPLETED or\n FAILED indicating object replication status.
\n If requesting an object from a destination bucket, Amazon S3 will return the\n x-amz-replication-status header with value REPLICA if the object in\n your request is a replica that Amazon S3 created and there is no replica modification\n replication in progress.
\n When replicating objects to multiple destination buckets, the\n x-amz-replication-status header acts differently. The header of the\n source object will only return a value of COMPLETED when replication is successful to\n all destinations. The header will remain at value PENDING until replication has\n completed for all destinations. If one or more destinations fails replication the\n header will return FAILED.
For more information, see Replication.
", + "smithy.api#documentation": "Amazon S3 can return this header if your request involves a bucket that is either a source or\n a destination in a replication rule.
\nIn replication, you have a source bucket on which you configure replication and\n destination bucket or buckets where Amazon S3 stores object replicas. When you request an object\n (GetObject) or object metadata (HeadObject) from these\n buckets, Amazon S3 will return the x-amz-replication-status header in the response\n as follows:
\n If requesting an object from the source bucket,\n Amazon S3 will return the x-amz-replication-status header if the object in\n your request is eligible for replication.
For example, suppose that in your replication configuration, you specify object\n prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix\n TaxDocs. Any objects you upload with this key name prefix, for\n example TaxDocs/document1.pdf, are eligible for replication. For any\n object request with this key name prefix, Amazon S3 will return the\n x-amz-replication-status header with value PENDING, COMPLETED or\n FAILED indicating object replication status.
\n If requesting an object from a destination\n bucket, Amazon S3 will return the x-amz-replication-status header\n with value REPLICA if the object in your request is a replica that Amazon S3 created and\n there is no replica modification replication in progress.
\n When replicating objects to multiple destination\n buckets, the x-amz-replication-status header acts\n differently. The header of the source object will only return a value of COMPLETED\n when replication is successful to all destinations. The header will remain at value\n PENDING until replication has completed for all destinations. If one or more\n destinations fails replication the header will return FAILED.
For more information, see Replication.
", "smithy.api#httpHeader": "x-amz-replication-status" } }, @@ -25889,14 +25889,14 @@ "target": "com.amazonaws.s3#PartsCount", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The count of parts this object has. This value is only returned if you specify partNumber\n in your request and the object was uploaded as a multipart upload.
The count of parts this object has. This value is only returned if you specify\n partNumber in your request and the object was uploaded as a multipart\n upload.
The Object Lock mode, if any, that's in effect for this object. This header is only\n returned if the requester has the s3:GetObjectRetention permission. For more\n information about S3 Object Lock, see Object\n Lock.
The Object Lock mode, if any, that's in effect for this object. This header is only\n returned if the requester has the s3:GetObjectRetention permission. For more\n information about S3 Object Lock, see Object Lock.
The name of the bucket containing the object.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The name of the bucket containing the object.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Because HeadObject returns only the metadata for an object, this parameter\n has no effect.
HeadObject returns only the metadata for an object. If the Range is satisfiable, only\n the ContentLength is affected in the response. If the Range is not\n satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.
To retrieve the checksum, this parameter must be enabled.
\nIn addition, if you enable ChecksumMode and the object is encrypted with\n Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the\n kms:Decrypt action for the request to succeed.
To retrieve the checksum, this parameter must be enabled.
\nIn addition, if you enable ChecksumMode and the object is encrypted with\n Amazon Web Services Key Management Service (Amazon Web Services KMS), you must have permission to use the\n kms:Decrypt action for the request to succeed.
If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal\n is an IAM User, it provides a user ARN value.
" + "smithy.api#documentation": "If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the\n principal is an IAM User, it provides a user ARN value.
" } }, "DisplayName": { @@ -26204,7 +26204,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.
\nFor information about the S3 Intelligent-Tiering storage class, see Storage class for\n automatically optimizing frequently and infrequently accessed objects.
" + "smithy.api#documentation": "Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.
\nFor information about the S3 Intelligent-Tiering storage class, see Storage class\n for automatically optimizing frequently and infrequently accessed\n objects.
" } }, "com.amazonaws.s3#IntelligentTieringConfigurationList": { @@ -26330,7 +26330,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see\n GET Bucket inventory in the Amazon S3 API Reference.\n
" + "smithy.api#documentation": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see\n GET Bucket inventory in the Amazon S3 API Reference.
" } }, "com.amazonaws.s3#InventoryConfigurationList": { @@ -26731,7 +26731,7 @@ "Date": { "target": "com.amazonaws.s3#Date", "traits": { - "smithy.api#documentation": "Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601\n Format.
" + "smithy.api#documentation": "Indicates at what date the object is to be moved or deleted. The date value must conform to the ISO 8601 format. \n The time is always midnight UTC.
" } }, "Days": { @@ -26750,7 +26750,7 @@ } }, "traits": { - "smithy.api#documentation": "Container for the expiration for the lifecycle of the object.
" + "smithy.api#documentation": "Container for the expiration for the lifecycle of the object.
\nFor more information see, Managing your storage\n lifecycle in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3#LifecycleRule": { @@ -26812,7 +26812,7 @@ } }, "traits": { - "smithy.api#documentation": "A lifecycle rule for individual objects in an Amazon S3 bucket.
" + "smithy.api#documentation": "A lifecycle rule for individual objects in an Amazon S3 bucket.
\nFor more information see, Managing your storage\n lifecycle in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3#LifecycleRuleAndOperator": { @@ -26901,7 +26901,7 @@ "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurationsOutput" }, "traits": { - "smithy.api#documentation": "Lists the analytics configurations for the bucket. You can have up to 1,000 analytics\n configurations per bucket.
\nThis action supports list pagination and does not return more than 100 configurations\n at a time. You should always check the IsTruncated element in the response. If\n there are no more configurations to list, IsTruncated is set to false. If\n there are more configurations to list, IsTruncated is set to true, and there\n will be a value in NextContinuationToken. You use the\n NextContinuationToken value to continue the pagination of the list by\n passing the value in continuation-token in the request to GET the next\n page.
To use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.
\nThe following operations are related to\n ListBucketAnalyticsConfigurations:
Lists the analytics configurations for the bucket. You can have up to 1,000 analytics\n configurations per bucket.
\nThis action supports list pagination and does not return more than 100 configurations at\n a time. You should always check the IsTruncated element in the response. If\n there are no more configurations to list, IsTruncated is set to false. If\n there are more configurations to list, IsTruncated is set to true, and there\n will be a value in NextContinuationToken. You use the\n NextContinuationToken value to continue the pagination of the list by\n passing the value in continuation-token in the request to GET the next\n page.
To use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.
\nThe following operations are related to\n ListBucketAnalyticsConfigurations:
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe 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 three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
\nThe 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 monitored and 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n ListBucketIntelligentTieringConfigurations include:
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe 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 three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
\nThe 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 monitored and 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to ListBucketIntelligentTieringConfigurations include:
Returns a list of inventory configurations for the bucket. You can have up to 1,000\n analytics configurations per bucket.
\nThis action supports list pagination and does not return more than 100 configurations\n at a time. Always check the IsTruncated element in the response. If there are\n no more configurations to list, IsTruncated is set to false. If there are more\n configurations to list, IsTruncated is set to true, and there is a value in\n NextContinuationToken. You use the NextContinuationToken value\n to continue the pagination of the list by passing the value in continuation-token in the\n request to GET the next page.
To use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory\n
\nThe following operations are related to\n ListBucketInventoryConfigurations:
Returns a list of inventory configurations for the bucket. You can have up to 1,000\n analytics configurations per bucket.
\nThis action supports list pagination and does not return more than 100 configurations at\n a time. Always check the IsTruncated element in the response. If there are no\n more configurations to list, IsTruncated is set to false. If there are more\n configurations to list, IsTruncated is set to true, and there is a value in\n NextContinuationToken. You use the NextContinuationToken value\n to continue the pagination of the list by passing the value in continuation-token in the\n request to GET the next page.
To use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory\n
\nThe following operations are related to\n ListBucketInventoryConfigurations:
Lists the metrics configurations for the bucket. The metrics configurations are only for\n the request metrics of the bucket and do not provide information on daily storage metrics.\n You can have up to 1,000 configurations per bucket.
\nThis action supports list pagination and does not return more than 100 configurations\n at a time. Always check the IsTruncated element in the response. If there are\n no more configurations to list, IsTruncated is set to false. If there are more\n configurations to list, IsTruncated is set to true, and there is a value in\n NextContinuationToken. You use the NextContinuationToken value\n to continue the pagination of the list by passing the value in\n continuation-token in the request to GET the next page.
To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For more information about metrics configurations and CloudWatch request metrics, see\n Monitoring Metrics with Amazon\n CloudWatch.
\nThe following operations are related to\n ListBucketMetricsConfigurations:
Lists the metrics configurations for the bucket. The metrics configurations are only for\n the request metrics of the bucket and do not provide information on daily storage metrics.\n You can have up to 1,000 configurations per bucket.
\nThis action supports list pagination and does not return more than 100 configurations at\n a time. Always check the IsTruncated element in the response. If there are no\n more configurations to list, IsTruncated is set to false. If there are more\n configurations to list, IsTruncated is set to true, and there is a value in\n NextContinuationToken. You use the NextContinuationToken value\n to continue the pagination of the list by passing the value in\n continuation-token in the request to GET the next page.
To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For more information about metrics configurations and CloudWatch request metrics, see\n Monitoring Metrics with Amazon CloudWatch.
\nThe following operations are related to\n ListBucketMetricsConfigurations:
Returns a list of all buckets owned by the authenticated sender of the request. To use\n this operation, you must have the s3:ListAllMyBuckets permission.
Returns a list of all buckets owned by the authenticated sender of the request. To use\n this operation, you must have the s3:ListAllMyBuckets permission.
For information about Amazon S3 buckets, see Creating, configuring, and\n working with Amazon S3 buckets.
", "smithy.api#http": { "method": "GET", "uri": "/", @@ -27275,7 +27275,7 @@ "target": "com.amazonaws.s3#ListMultipartUploadsOutput" }, "traits": { - "smithy.api#documentation": "This action lists in-progress multipart uploads. An in-progress multipart upload is a\n multipart upload that has been initiated using the Initiate Multipart Upload request, but\n has not yet been completed or aborted.
\nThis action returns at most 1,000 multipart uploads in the response. 1,000 multipart\n uploads is the maximum number of uploads a response can include, which is also the default\n value. You can further limit the number of uploads in a response by specifying the\n max-uploads parameter in the response. If additional multipart uploads\n satisfy the list criteria, the response will contain an IsTruncated element\n with the value true. To list the additional multipart uploads, use the\n key-marker and upload-id-marker request parameters.
In the response, the uploads are sorted by key. If your application has initiated more\n than one multipart upload using the same object key, then uploads in the response are first\n sorted by key. Additionally, uploads are sorted in ascending order within each key by the\n upload initiation time.
\nFor more information on multipart uploads, see Uploading Objects Using Multipart\n Upload.
\nFor information on permissions required to use the multipart upload API, see Multipart Upload and\n Permissions.
\nThe following operations are related to ListMultipartUploads:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nThis action lists in-progress multipart uploads. An in-progress multipart upload is a\n multipart upload that has been initiated using the Initiate Multipart Upload request, but\n has not yet been completed or aborted.
\nThis action returns at most 1,000 multipart uploads in the response. 1,000 multipart\n uploads is the maximum number of uploads a response can include, which is also the default\n value. You can further limit the number of uploads in a response by specifying the\n max-uploads parameter in the response. If additional multipart uploads\n satisfy the list criteria, the response will contain an IsTruncated element\n with the value true. To list the additional multipart uploads, use the\n key-marker and upload-id-marker request parameters.
In the response, the uploads are sorted by key. If your application has initiated more\n than one multipart upload using the same object key, then uploads in the response are first\n sorted by key. Additionally, uploads are sorted in ascending order within each key by the\n upload initiation time.
\nFor more information on multipart uploads, see Uploading Objects Using Multipart\n Upload.
\nFor information on permissions required to use the multipart upload API, see Multipart Upload\n and Permissions.
\nThe following operations are related to ListMultipartUploads:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nThe name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.
" + "smithy.api#documentation": "The name of the bucket to which the multipart upload was initiated. Does not return the\n access point ARN or access point alias if used.
" } }, "KeyMarker": { @@ -27375,7 +27375,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The name of the bucket to which the multipart upload was initiated.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The name of the bucket to which the multipart upload was initiated.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Returns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.
\n\n To use this operation, you must have permissions to perform the \n s3:ListBucketVersions action. Be aware of the name difference.\n
A 200 OK response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately.
\nTo use this operation, you must have READ access to the bucket.
\nThis action is not supported by Amazon S3 on Outposts.
\nThe following operations are related to\n ListObjectVersions:
\n ListObjectsV2\n
\n\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nReturns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.
\n To use this operation, you must have permissions to perform the\n s3:ListBucketVersions action. Be aware of the name difference.
A 200 OK response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately.
\nTo use this operation, you must have READ access to the bucket.
\nThis action is not supported by Amazon S3 on Outposts.
\nThe following operations are related to ListObjectVersions:
\n ListObjectsV2\n
\n\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nSets the maximum number of keys returned in the response. By default the action returns up\n to 1,000 key names. The response might contain fewer keys but will never contain more. If\n additional keys satisfy the search criteria, but were not returned because max-keys was\n exceeded, the response contains
Sets the maximum number of keys returned in the response. By default the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain more.\n If additional keys satisfy the search criteria, but were not returned because max-keys was\n exceeded, the response contains
All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating\n the number of returns.
\nA response can contain CommonPrefixes only if you specify a delimiter.
\nCommonPrefixes contains all (if there are any) keys between Prefix and the next\n occurrence of the string specified by the delimiter.
\nCommonPrefixes lists keys that act like subdirectories in the directory specified by\n Prefix.
\nFor example, if the prefix is notes/ and the delimiter is a slash (/) as in\n notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a\n common prefix count as a single return when calculating the number of returns.
", + "smithy.api#documentation": "All of the keys (up to 1,000) rolled up in a common prefix count as a single return when\n calculating the number of returns.
\nA response can contain CommonPrefixes only if you specify a delimiter.
\nCommonPrefixes contains all (if there are any) keys between Prefix and the next\n occurrence of the string specified by the delimiter.
\nCommonPrefixes lists keys that act like subdirectories in the directory specified by\n Prefix.
\nFor example, if the prefix is notes/ and the delimiter is a slash (/) as in\n notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a\n common prefix count as a single return when calculating the number of returns.
", "smithy.api#xmlFlattened": {} } }, @@ -27717,7 +27717,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The name of the bucket containing the objects.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The name of the bucket containing the objects.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after\n this specified key. Marker can be any key in the bucket.
", + "smithy.api#documentation": "Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after\n this specified key. Marker can be any key in the bucket.
", "smithy.api#httpQuery": "marker" } }, @@ -27749,7 +27749,7 @@ "target": "com.amazonaws.s3#MaxKeys", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Sets the maximum number of keys returned in the response. By default the action returns up\n to 1,000 key names. The response might contain fewer keys but will never contain more.\n
", + "smithy.api#documentation": "Sets the maximum number of keys returned in the response. By default the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain more.\n
", "smithy.api#httpQuery": "max-keys" } }, @@ -27793,7 +27793,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use\n the request parameters as selection criteria to return a subset of the objects in a bucket. A \n 200 OK response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately. \n Objects are returned sorted in an ascending order of the respective key names in the list.\n For more information about listing objects, see Listing object keys \n programmatically\n
To use this operation, you must have READ access to the bucket.
\nTo use this action in an Identity and Access Management (IAM) policy, you must\n have permissions to perform the s3:ListBucket action. The bucket owner has\n this permission by default and can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
This section describes the latest revision of this action. We recommend that you use this\n revised API for application development. For backward compatibility, Amazon S3 continues to\n support the prior version of this API, ListObjects.
\nTo get a list of your buckets, see ListBuckets.
\nThe following operations are related to ListObjectsV2:
\n GetObject\n
\n\n PutObject\n
\n\n CreateBucket\n
\nReturns some or all (up to 1,000) of the objects in a bucket with each request. You can\n use the request parameters as selection criteria to return a subset of the objects in a\n bucket. A 200 OK response can contain valid or invalid XML. Make sure to\n design your application to parse the contents of the response and handle it appropriately.\n Objects are returned sorted in an ascending order of the respective key names in the list.\n For more information about listing objects, see Listing object keys\n programmatically\n
To use this operation, you must have READ access to the bucket.
\nTo use this action in an Identity and Access Management (IAM) policy, you must have permissions to perform\n the s3:ListBucket action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
This section describes the latest revision of this action. We recommend that you use\n this revised API for application development. For backward compatibility, Amazon S3 continues\n to support the prior version of this API, ListObjects.
\nTo get a list of your buckets, see ListBuckets.
\nThe following operations are related to ListObjectsV2:
\n GetObject\n
\n\n PutObject\n
\n\n CreateBucket\n
\nThe bucket name.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The bucket name.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Sets the maximum number of keys returned in the response. By default the action returns up\n to 1,000 key names. The response might contain fewer keys but will never contain\n more.
" + "smithy.api#documentation": "Sets the maximum number of keys returned in the response. By default the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain\n more.
" } }, "CommonPrefixes": { "target": "com.amazonaws.s3#CommonPrefixList", "traits": { - "smithy.api#documentation": "All of the keys (up to 1,000) rolled up into a common prefix count as a single return when calculating\n the number of returns.
\nA response can contain CommonPrefixes only if you specify a\n delimiter.
\n CommonPrefixes contains all (if there are any) keys between\n Prefix and the next occurrence of the string specified by a\n delimiter.
\n CommonPrefixes lists keys that act like subdirectories in the directory\n specified by Prefix.
For example, if the prefix is notes/ and the delimiter is a slash\n (/) as in notes/summer/july, the common prefix is\n notes/summer/. All of the keys that roll up into a common prefix count as a\n single return when calculating the number of returns.
All of the keys (up to 1,000) rolled up into a common prefix count as a single return\n when calculating the number of returns.
\nA response can contain CommonPrefixes only if you specify a\n delimiter.
\n CommonPrefixes contains all (if there are any) keys between\n Prefix and the next occurrence of the string specified by a\n delimiter.
\n CommonPrefixes lists keys that act like subdirectories in the directory\n specified by Prefix.
For example, if the prefix is notes/ and the delimiter is a slash\n (/) as in notes/summer/july, the common prefix is\n notes/summer/. All of the keys that roll up into a common prefix count as a\n single return when calculating the number of returns.
KeyCount is the number of keys returned with this request. KeyCount will always be less\n than or equals to MaxKeys field. Say you ask for 50 keys, your result will include less than\n equals 50 keys
" + "smithy.api#documentation": "KeyCount is the number of keys returned with this request. KeyCount will always be less\n than or equal to the MaxKeys field. Say you ask for 50 keys, your result will\n include 50 keys or fewer.
Bucket name to list.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
Bucket name to list.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Sets the maximum number of keys returned in the response. By default the action returns up\n to 1,000 key names. The response might contain fewer keys but will never contain\n more.
", + "smithy.api#documentation": "Sets the maximum number of keys returned in the response. By default the action returns\n up to 1,000 key names. The response might contain fewer keys but will never contain\n more.
", "smithy.api#httpQuery": "max-keys" } }, @@ -27985,7 +27985,7 @@ "target": "com.amazonaws.s3#ListPartsOutput" }, "traits": { - "smithy.api#documentation": "Lists the parts that have been uploaded for a specific multipart upload. This operation\n must include the upload ID, which you obtain by sending the initiate multipart upload\n request (see CreateMultipartUpload).\n This request returns a maximum of 1,000 uploaded parts. The default number of parts\n returned is 1,000 parts. You can restrict the number of parts returned by specifying the\n max-parts request parameter. If your multipart upload consists of more than\n 1,000 parts, the response returns an IsTruncated field with the value of true,\n and a NextPartNumberMarker element. In subsequent ListParts\n requests you can include the part-number-marker query string parameter and set its value to\n the NextPartNumberMarker field value from the previous response.
If the upload was created using a checksum algorithm, you will need to have permission\n to the kms:Decrypt action for the request to succeed.\n
For more information on multipart uploads, see Uploading Objects Using Multipart\n Upload.
\nFor information on permissions required to use the multipart upload API, see Multipart Upload and\n Permissions.
\nThe following operations are related to ListParts:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n GetObjectAttributes\n
\n\n ListMultipartUploads\n
\nLists the parts that have been uploaded for a specific multipart upload. This operation\n must include the upload ID, which you obtain by sending the initiate multipart upload\n request (see CreateMultipartUpload).\n This request returns a maximum of 1,000 uploaded parts. The default number of parts\n returned is 1,000 parts. You can restrict the number of parts returned by specifying the\n max-parts request parameter. If your multipart upload consists of more than\n 1,000 parts, the response returns an IsTruncated field with the value of true,\n and a NextPartNumberMarker element. In subsequent ListParts\n requests you can include the part-number-marker query string parameter and set its value to\n the NextPartNumberMarker field value from the previous response.
If the upload was created using a checksum algorithm, you will need to have permission\n to the kms:Decrypt action for the request to succeed.
For more information on multipart uploads, see Uploading Objects Using Multipart\n Upload.
\nFor information on permissions required to use the multipart upload API, see Multipart Upload\n and Permissions.
\nThe following operations are related to ListParts:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n GetObjectAttributes\n
\n\n ListMultipartUploads\n
\nIf the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, then the response includes this header indicating when the initiated multipart\n upload will become eligible for abort operation. For more information, see Aborting\n Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
\nThe response will also include the x-amz-abort-rule-id header that will\n provide the ID of the lifecycle configuration rule that defines this action.
If the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, then the response includes this header indicating when the initiated multipart\n upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
\nThe response will also include the x-amz-abort-rule-id header that will\n provide the ID of the lifecycle configuration rule that defines this action.
The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.
" + "smithy.api#documentation": "The name of the bucket to which the multipart upload was initiated. Does not return the\n access point ARN or access point alias if used.
" } }, "Key": { @@ -28110,7 +28110,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The name of the bucket to which the parts are being uploaded.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The name of the bucket to which the parts are being uploaded.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Container for granting information.
\nBuckets that use the bucket owner enforced setting for Object\n Ownership don't support target grants. For more information, see Permissions for server access log delivery in the\n Amazon S3 User Guide.
" + "smithy.api#documentation": "Container for granting information.
\nBuckets that use the bucket owner enforced setting for Object Ownership don't support\n target grants. For more information, see Permissions for server access log delivery in the\n Amazon S3 User Guide.
" } }, "TargetPrefix": { @@ -28396,14 +28396,14 @@ "Id": { "target": "com.amazonaws.s3#MetricsId", "traits": { - "smithy.api#documentation": "The ID used to identify the metrics configuration.
", + "smithy.api#documentation": "The ID used to identify the metrics configuration. The ID has a 64 character limit and\n can only contain letters, numbers, periods, dashes, and underscores.
", "smithy.api#required": {} } }, "Filter": { "target": "com.amazonaws.s3#MetricsFilter", "traits": { - "smithy.api#documentation": "Specifies a metrics configuration filter. The metrics configuration will only include\n objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction\n (MetricsAndOperator).
" + "smithy.api#documentation": "Specifies a metrics configuration filter. The metrics configuration will only include\n objects that meet the filter's criteria. A filter must be a prefix, an object tag, an\n access point ARN, or a conjunction (MetricsAndOperator).
" } } }, @@ -28446,7 +28446,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies a metrics configuration filter. The metrics configuration only includes\n objects that meet the filter's criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction\n (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.
" + "smithy.api#documentation": "Specifies a metrics configuration filter. The metrics configuration only includes\n objects that meet the filter's criteria. A filter must be a prefix, an object tag, an\n access point ARN, or a conjunction (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.
" } }, "com.amazonaws.s3#MetricsId": { @@ -28589,14 +28589,14 @@ "target": "com.amazonaws.s3#Days", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.
" + "smithy.api#documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. The value must be a non-zero positive integer. For information about the\n noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the\n Amazon S3 User Guide.
" } }, "NewerNoncurrentVersions": { "target": "com.amazonaws.s3#VersionCount", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent\n noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent\n versions, see Lifecycle configuration elements\n in the Amazon S3 User Guide.
" + "smithy.api#documentation": "Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more\n recent noncurrent versions, Amazon S3 will take the associated action. For more information\n about noncurrent versions, see Lifecycle configuration\n elements in the Amazon S3 User Guide.
" } } }, @@ -28624,12 +28624,12 @@ "target": "com.amazonaws.s3#VersionCount", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more recent\n noncurrent versions, Amazon S3 will take the associated action. For more information about noncurrent\n versions, see Lifecycle configuration elements\n in the Amazon S3 User Guide.
" + "smithy.api#documentation": "Specifies how many noncurrent versions Amazon S3 will retain. If there are this many more\n recent noncurrent versions, Amazon S3 will take the associated action. For more information\n about noncurrent versions, see Lifecycle configuration\n elements in the Amazon S3 User Guide.
" } } }, "traits": { - "smithy.api#documentation": "Container for the transition rule that describes when noncurrent objects transition to\n the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING,\n GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is\n versioning-enabled (or versioning is suspended), you can set this action to request that\n Amazon S3 transition noncurrent object versions to the STANDARD_IA,\n ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or\n DEEP_ARCHIVE storage class at a specific period in the object's\n lifetime.
Container for the transition rule that describes when noncurrent objects transition to\n the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING,\n GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage\n class. If your bucket is versioning-enabled (or versioning is suspended), you can set this\n action to request that Amazon S3 transition noncurrent object versions to the\n STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING,\n GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage\n class at a specific period in the object's lifetime.
Specifies object key name filtering rules. For information about key name filtering, see\n Configuring\n Event Notifications in the Amazon S3 User Guide.
" + "smithy.api#documentation": "Specifies object key name filtering rules. For information about key name filtering, see\n Configuring event notifications using object key name filtering in the Amazon S3 User Guide.
" } }, "com.amazonaws.s3#NotificationId": { @@ -28722,7 +28722,7 @@ "ETag": { "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "The entity tag is a hash of the object. The ETag reflects changes only to the contents\n of an object, not its metadata. The ETag may or may not be an MD5 digest of the object\n data. Whether or not it is depends on how the object was created and how it is encrypted as\n described below:
\nObjects created by the PUT Object, POST Object, or Copy operation, or through the\n Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are\n an MD5 digest of their object data.
\nObjects created by the PUT Object, POST Object, or Copy operation, or through the\n Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are\n not an MD5 digest of their object data.
\nIf an object is created by either the Multipart Upload or Part Copy operation, the\n ETag is not an MD5 digest, regardless of the method of encryption. If an object\n is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a\n Multipart Upload, and therefore the ETag will not be an MD5 digest.
\nThe entity tag is a hash of the object. The ETag reflects changes only to the contents\n of an object, not its metadata. The ETag may or may not be an MD5 digest of the object\n data. Whether or not it is depends on how the object was created and how it is encrypted as\n described below:
\nObjects created by the PUT Object, POST Object, or Copy operation, or through the\n Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that\n are an MD5 digest of their object data.
\nObjects created by the PUT Object, POST Object, or Copy operation, or through the\n Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are\n not an MD5 digest of their object data.
\nIf an object is created by either the Multipart Upload or Part Copy operation, the\n ETag is not an MD5 digest, regardless of the method of encryption. If an object is\n larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a\n Multipart Upload, and therefore the ETag will not be an MD5 digest.
\nIndicates whether this bucket has an Object Lock configuration enabled.\n Enable ObjectLockEnabled when you apply ObjectLockConfiguration\n to a bucket.
Indicates whether this bucket has an Object Lock configuration enabled. Enable\n ObjectLockEnabled when you apply ObjectLockConfiguration to a\n bucket.
Specifies the Object Lock rule for the specified object. Enable the this rule when you apply\n ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period.\n The period can be either Days or Years but you must select one.\n You cannot specify Days and Years at the same time.
Specifies the Object Lock rule for the specified object. Enable the this rule when you\n apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode\n and a period. The period can be either Days or Years but you must\n select one. You cannot specify Days and Years at the same\n time.
The default Object Lock retention mode and period that you want to apply to new objects\n placed in the specified bucket. Bucket settings require both a mode and a period.\n The period can be either Days or Years but you must select one.\n You cannot specify Days and Years at the same time.
The default Object Lock retention mode and period that you want to apply to new objects\n placed in the specified bucket. Bucket settings require both a mode and a period. The\n period can be either Days or Years but you must select one. You\n cannot specify Days and Years at the same time.
The container element for object ownership for a bucket's ownership controls.
\nBucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket\n owner if the objects are uploaded with the bucket-owner-full-control canned\n ACL.
ObjectWriter - The uploading account will own the object if the object is uploaded with\n the bucket-owner-full-control canned ACL.
BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. \n The bucket owner automatically owns and has full control over every object in the bucket. The bucket only\n accepts PUT requests that don't specify an ACL or bucket owner full control\n ACLs, such as the bucket-owner-full-control canned\n ACL or an equivalent form of this ACL expressed in the XML format.
The container element for object ownership for a bucket's ownership controls.
\nBucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket\n owner if the objects are uploaded with the bucket-owner-full-control canned\n ACL.
ObjectWriter - The uploading account will own the object if the object is uploaded with\n the bucket-owner-full-control canned ACL.
BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect\n permissions. The bucket owner automatically owns and has full control over every object in\n the bucket. The bucket only accepts PUT requests that don't specify an ACL or bucket owner\n full control ACLs, such as the bucket-owner-full-control canned ACL or an\n equivalent form of this ACL expressed in the XML format.
Container for the display name of the owner.
" + "smithy.api#documentation": "Container for the display name of the owner. This value is only supported in the\n following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nSpecifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting\n this element to TRUE restricts access to this bucket to only Amazon Web Service\n principals and authorized users within this account if the bucket has a public\n policy.
Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.
", + "smithy.api#documentation": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting\n this element to TRUE restricts access to this bucket to only Amazon Web Service principals and authorized users within this account if the bucket has\n a public policy.
Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.
", "smithy.api#xmlName": "RestrictPublicBuckets" } } @@ -29673,7 +29673,7 @@ "aws.protocols#httpChecksum": { "requestAlgorithmMember": "ChecksumAlgorithm" }, - "smithy.api#documentation": "Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a\n bucket-level feature that enables you to perform faster data transfers to Amazon S3.
\n To use this operation, you must have permission to perform the\n s3:PutAccelerateConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
The Transfer Acceleration state of a bucket can be set to one of the following two\n values:
\nEnabled – Enables accelerated data transfers to the bucket.
\nSuspended – Disables accelerated data transfers to the bucket.
\nThe GetBucketAccelerateConfiguration action returns the transfer acceleration\n state of a bucket.
\nAfter setting the Transfer Acceleration state of a bucket to Enabled, it might take up\n to thirty minutes before the data transfer rates to the bucket increase.
\nThe name of the bucket used for Transfer Acceleration must be DNS-compliant and must\n not contain periods (\".\").
\nFor more information about transfer acceleration, see Transfer Acceleration.
\nThe following operations are related to\n PutBucketAccelerateConfiguration:
\n CreateBucket\n
\nSets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a\n bucket-level feature that enables you to perform faster data transfers to Amazon S3.
\n To use this operation, you must have permission to perform the\n s3:PutAccelerateConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
The Transfer Acceleration state of a bucket can be set to one of the following two\n values:
\nEnabled – Enables accelerated data transfers to the bucket.
\nSuspended – Disables accelerated data transfers to the bucket.
\nThe GetBucketAccelerateConfiguration action returns the transfer acceleration state\n of a bucket.
\nAfter setting the Transfer Acceleration state of a bucket to Enabled, it might take up\n to thirty minutes before the data transfer rates to the bucket increase.
\nThe name of the bucket used for Transfer Acceleration must be DNS-compliant and must\n not contain periods (\".\").
\nFor more information about transfer acceleration, see Transfer\n Acceleration.
\nThe following operations are related to\n PutBucketAccelerateConfiguration:
\n CreateBucket\n
\nSets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set\n 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:
\nSpecify the ACL in the request body
\nSpecify permissions using request headers
\nYou cannot specify access permission using both the body and the request\n headers.
\nDepending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. \n You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and \n return the AccessControlListNotSupported error code. Requests to read ACLs are still supported.\n For more information, see Controlling object ownership\n in the Amazon S3 User Guide.
\n Access Permissions\n
\nYou can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. Specify the canned ACL name as the\n value of x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n the x-amz-acl header to set a canned ACL. These parameters map to the\n set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)\n Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-write header grants create,\n overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and\n two Amazon Web Services accounts identified by their email addresses.
\n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\",\n id=\"111122223333\", id=\"555566667777\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\n\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request
\nBy URI:
\n\n
By Email address:
\n\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\n\n Related Resources\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetObjectAcl\n
\nSets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set the ACL of a\n bucket, you must have WRITE_ACP permission.
You can use one of the following two ways to set a bucket's permissions:
\nSpecify the ACL in the request body
\nSpecify permissions using request headers
\nYou cannot specify access permission using both the body and the request\n headers.
\nDepending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.
You can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. Specify the canned ACL name as the\n value of x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned\n ACL.
Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n the x-amz-acl header to set a canned ACL. These parameters map to the\n set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control\n List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an\n Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-write header grants create,\n overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and\n two Amazon Web Services accounts identified by their email addresses.
\n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\",\n id=\"111122223333\", id=\"555566667777\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request
\nBy URI:
\n\n
By Email address:
\n\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nThe following operations are related to PutBucketAcl:
\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetObjectAcl\n
\nAllows grantee to create new objects in the bucket.
\nFor the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
", + "smithy.api#documentation": "Allows grantee to create new objects in the bucket.
\nFor the bucket and object owners of existing objects, also allows deletions and\n overwrites of those objects.
", "smithy.api#httpHeader": "x-amz-grant-write" } }, @@ -29843,7 +29843,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Sets an analytics configuration for the bucket (specified by the analytics configuration\n ID). You can have up to 1,000 analytics configurations per bucket.
\nYou can choose to have storage class analysis export analysis reports sent to a\n comma-separated values (CSV) flat file. See the DataExport request element.\n Reports are updated daily and are based on the object filters that you configure. When\n selecting data export, you specify a destination bucket and an optional destination prefix\n where the file is written. You can export the data to a destination bucket in a different\n account. However, the destination bucket must be in the same Region as the bucket that you\n are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class\n Analysis.
You must create a bucket policy on the destination bucket where the exported file is\n written to grant permissions to Amazon S3 to write objects to the bucket. For an example\n policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
\nTo use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
\n Special Errors\n
\n\n HTTP Error: HTTP 400 Bad Request\n
\n\n Code: InvalidArgument\n
\n\n Cause: Invalid argument.\n
\n\n HTTP Error: HTTP 400 Bad Request\n
\n\n Code: TooManyConfigurations\n
\n\n Cause: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.\n
\n\n HTTP Error: HTTP 403 Forbidden\n
\n\n Code: AccessDenied\n
\n\n Cause: You are not the owner of the specified bucket, or you do\n not have the s3:PutAnalyticsConfiguration bucket permission to set the\n configuration on the bucket.\n
\n\n Related Resources\n
\nSets an analytics configuration for the bucket (specified by the analytics configuration\n ID). You can have up to 1,000 analytics configurations per bucket.
\nYou can choose to have storage class analysis export analysis reports sent to a\n comma-separated values (CSV) flat file. See the DataExport request element.\n Reports are updated daily and are based on the object filters that you configure. When\n selecting data export, you specify a destination bucket and an optional destination prefix\n where the file is written. You can export the data to a destination bucket in a different\n account. However, the destination bucket must be in the same Region as the bucket that you\n are making the PUT analytics configuration to. For more information, see Amazon S3\n Analytics – Storage Class Analysis.
You must create a bucket policy on the destination bucket where the exported file is\n written to grant permissions to Amazon S3 to write objects to the bucket. For an example\n policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
\nTo use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
\n PutBucketAnalyticsConfiguration has the following special errors:
\n HTTP Error: HTTP 400 Bad Request\n
\n\n Code: InvalidArgument\n
\n\n Cause: Invalid argument.\n
\n\n HTTP Error: HTTP 400 Bad Request\n
\n\n Code: TooManyConfigurations\n
\n\n Cause: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.\n
\n\n HTTP Error: HTTP 403 Forbidden\n
\n\n Code: AccessDenied\n
\n\n Cause: You are not the owner of the specified bucket, or you do\n not have the s3:PutAnalyticsConfiguration bucket permission to set the\n configuration on the bucket.\n
\nThe following operations are related to PutBucketAnalyticsConfiguration:
Sets the cors configuration for your bucket. If the configuration exists,\n Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS\n 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\n requests. For example, you might want to enable a request whose origin is\n http://www.example.com to access your Amazon S3 bucket at\n my.example.bucket.com by using the browser's XMLHttpRequest\n capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the\n cors subresource to the bucket. The cors subresource is an XML\n document in which you configure rules that identify origins and the HTTP methods that can\n 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\n bucket, it evaluates the cors configuration on the bucket and uses the first\n CORSRule rule that matches the incoming browser request to enable a\n cross-origin request. For a rule to match, the following conditions must be met:
The request's Origin header must match AllowedOrigin\n elements.
The request method (for example, GET, PUT, HEAD, and so on) or the\n Access-Control-Request-Method header in case of a pre-flight\n OPTIONS request must be one of the AllowedMethod\n elements.
Every header specified in the Access-Control-Request-Headers request\n header of a pre-flight request must match an AllowedHeader element.\n
For more information about CORS, go to Enabling\n Cross-Origin Resource Sharing in the Amazon S3 User Guide.
\n\n Related Resources\n
\n\n GetBucketCors\n
\n\n DeleteBucketCors\n
\n\n RESTOPTIONSobject\n
\nSets the cors configuration for your bucket. If the configuration exists,\n Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS\n 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\n requests. For example, you might want to enable a request whose origin is\n http://www.example.com to access your Amazon S3 bucket at\n my.example.bucket.com by using the browser's XMLHttpRequest\n capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the\n cors subresource to the bucket. The cors subresource is an XML\n document in which you configure rules that identify origins and the HTTP methods that can\n 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\n bucket, it evaluates the cors configuration on the bucket and uses the first\n CORSRule rule that matches the incoming browser request to enable a\n cross-origin request. For a rule to match, the following conditions must be met:
The request's Origin header must match AllowedOrigin\n elements.
The request method (for example, GET, PUT, HEAD, and so on) or the\n Access-Control-Request-Method header in case of a pre-flight\n OPTIONS request must be one of the AllowedMethod\n elements.
Every header specified in the Access-Control-Request-Headers request\n header of a pre-flight request must match an AllowedHeader element.\n
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in\n the Amazon S3 User Guide.
\nThe following operations are related to PutBucketCors:
\n GetBucketCors\n
\n\n DeleteBucketCors\n
\n\n RESTOPTIONSobject\n
\nDescribes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling Cross-Origin Resource\n Sharing in the Amazon S3 User Guide.
", + "smithy.api#documentation": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling\n Cross-Origin Resource Sharing in the\n Amazon S3 User Guide.
", "smithy.api#httpPayload": {}, "smithy.api#required": {}, "smithy.api#xmlName": "CORSConfiguration" @@ -29977,7 +29977,7 @@ "requestAlgorithmMember": "ChecksumAlgorithm", "requestChecksumRequired": true }, - "smithy.api#documentation": "This action uses the encryption subresource to configure default\n 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\n (SSE-S3) or customer managed keys (SSE-KMS). If you specify default encryption\n using SSE-KMS, you can also configure Amazon S3 Bucket Key. When the default encryption is SSE-KMS, if\n you upload an object to the bucket and do not specify the KMS key to use for encryption, Amazon S3\n uses the default Amazon Web Services managed KMS key for your account. For information about default\n encryption, see Amazon S3 default bucket encryption\n in the Amazon S3 User Guide. For more information about S3 Bucket Keys,\n see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
\nThis action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature\n Version 4).
\nTo use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon S3 User Guide.
\n Related Resources\n
\n\n GetBucketEncryption\n
\nThis action uses the encryption subresource to configure default encryption\n and Amazon S3 Bucket Keys for an existing bucket.
By default, all buckets have a default encryption configuration that\n uses server-side encryption with Amazon S3 managed keys (SSE-S3).\n You can optionally configure default encryption for a bucket by using server-side\n encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). If you specify default encryption by using\n SSE-KMS, you can also configure Amazon S3 Bucket Keys. For information about bucket default encryption,\n see Amazon S3\n bucket default encryption in the Amazon S3 User Guide. For more\n information about S3 Bucket Keys, see Amazon S3 Bucket Keys in the\n Amazon S3 User Guide.
\nThis action requires Amazon Web Services Signature Version 4. For more information, see \n Authenticating Requests (Amazon Web Services Signature Version 4).
\nTo use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
The following operations are related to PutBucketEncryption:
\n GetBucketEncryption\n
\nSpecifies default encryption for a bucket using server-side encryption with Amazon S3-managed\n keys (SSE-S3) or customer managed keys (SSE-KMS). For information about\n the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption\n in the Amazon S3 User Guide.
", + "smithy.api#documentation": "Specifies default encryption for a bucket using server-side encryption with different\n key options. By default, all buckets have a default encryption configuration that\n uses server-side encryption with Amazon S3 managed keys (SSE-S3). You can optionally configure default encryption for a bucket by using server-side\n encryption with an Amazon Web Services KMS key (SSE-KMS) or a customer-provided key (SSE-C). For information about the bucket default\n encryption feature, see Amazon S3 Bucket Default Encryption\n in the Amazon S3 User Guide.
", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.rules#contextParam": { @@ -30002,7 +30002,7 @@ "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.
\nFor requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
", + "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the server-side encryption\n configuration.
\nFor requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
", "smithy.api#httpHeader": "Content-MD5" } }, @@ -30042,7 +30042,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Puts a S3 Intelligent-Tiering configuration to the specified bucket.\n You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.
\nThe 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 three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
\nThe 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 monitored and 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n PutBucketIntelligentTieringConfiguration include:
You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically\n move objects stored in the S3 Intelligent-Tiering storage class to the\n Archive Access or Deep Archive Access tier.
\n\n Special Errors\n
\n\n HTTP 400 Bad Request Error\n
\n\n Code: InvalidArgument
\n\n Cause: Invalid Argument
\n\n HTTP 400 Bad Request Error\n
\n\n Code: TooManyConfigurations
\n\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.
\n\n HTTP 403 Forbidden Error\n
\n\n Code: AccessDenied
\n\n Cause: You are not the owner of the specified bucket,\n or you do not have the s3:PutIntelligentTieringConfiguration bucket\n permission to set the configuration on the bucket.
Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to\n 1,000 S3 Intelligent-Tiering configurations per bucket.
\nThe 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 three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.
\nThe 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 monitored and 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.
\nFor more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to PutBucketIntelligentTieringConfiguration include:
You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically\n move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access\n or Deep Archive Access tier.
\n\n PutBucketIntelligentTieringConfiguration has the following special errors:
\n Code: InvalidArgument
\n\n Cause: Invalid Argument
\n\n Code: TooManyConfigurations
\n\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.
\n\n Cause: You are not the owner of the specified bucket,\n or you do not have the s3:PutIntelligentTieringConfiguration\n bucket permission to set the configuration on the bucket.
This implementation of the PUT action adds an inventory configuration\n (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory\n configurations per bucket.
Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly\n basis, and the results are published to a flat file. The bucket that is inventoried is\n called the source bucket, and the bucket where the inventory flat file\n is stored is called the destination bucket. The\n destination bucket must be in the same Amazon Web Services Region as the\n source bucket.
\nWhen you configure an inventory for a source bucket, you specify\n the destination bucket where you want the inventory to be stored, and\n whether to generate the inventory daily or weekly. You can also configure what object\n metadata to include and whether to inventory all object versions or only current versions.\n For more information, see Amazon S3\n Inventory in the Amazon S3 User Guide.
\nYou must create a bucket policy on the destination bucket to\n grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an\n example policy, see \n Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
\nTo use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon S3 User Guide.
\n Special Errors\n
\n\n HTTP 400 Bad Request Error\n
\n\n Code: InvalidArgument
\n\n Cause: Invalid Argument
\n\n HTTP 400 Bad Request Error\n
\n\n Code: TooManyConfigurations
\n\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.
\n\n HTTP 403 Forbidden Error\n
\n\n Code: AccessDenied
\n\n Cause: You are not the owner of the specified bucket,\n or you do not have the s3:PutInventoryConfiguration bucket\n permission to set the configuration on the bucket.
\n Related Resources\n
\nThis implementation of the PUT action adds an inventory configuration\n (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory\n configurations per bucket.
Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly\n basis, and the results are published to a flat file. The bucket that is inventoried is\n called the source bucket, and the bucket where the inventory flat file\n is stored is called the destination bucket. The\n destination bucket must be in the same Amazon Web Services Region as the\n source bucket.
\nWhen you configure an inventory for a source bucket, you specify\n the destination bucket where you want the inventory to be stored, and\n whether to generate the inventory daily or weekly. You can also configure what object\n metadata to include and whether to inventory all object versions or only current versions.\n For more information, see Amazon S3 Inventory in the\n Amazon S3 User Guide.
\nYou must create a bucket policy on the destination bucket to\n grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an\n example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
\nTo use this operation, you must have permission to perform the\n s3:PutInventoryConfiguration action. The bucket owner has this permission\n by default and can grant this permission to others.
The s3:PutInventoryConfiguration permission allows a user to create an\n S3\n Inventory report that includes all object metadata fields available and to\n specify the destination bucket to store the inventory. A user with read access to objects\n in the destination bucket can also access all object metadata fields that are available in\n the inventory report.
To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the\n Amazon S3 User Guide. For more information about the metadata fields\n available in S3 Inventory, see Amazon S3\n Inventory lists in the Amazon S3 User Guide. For more\n information about permissions, see Permissions related to bucket subresource operations and Identity and\n access management in Amazon S3 in the Amazon S3 User Guide.
\n\n PutBucketInventoryConfiguration has the following special errors:
\n Code: InvalidArgument
\n\n Cause: Invalid Argument
\n\n Code: TooManyConfigurations
\n\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.
\n\n Cause: You are not the owner of the specified bucket,\n or you do not have the s3:PutInventoryConfiguration bucket\n permission to set the configuration on the bucket.
The following operations are related to PutBucketInventoryConfiguration:
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if\n you want to retain any configuration details, they must be included in the new lifecycle\n configuration. For information about lifecycle configuration, see Managing your storage\n lifecycle.
\nBucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The previous version of the API supported\n filtering based only on an object key name prefix, which is supported for backward\n compatibility. For the related API description, see PutBucketLifecycle.
\n\n Rules\n
\nYou specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle\n configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists\n of the following:
\nFilter identifying a subset of objects to which the rule applies. The filter can\n be based on a key name prefix, object tags, or a combination of both.
\nStatus whether the rule is in effect.
\nOne or more lifecycle transition and expiration actions that you want Amazon S3 to\n perform on the objects identified by the filter. If the state of your bucket is\n versioning-enabled or versioning-suspended, you can have many versions of the same\n object (one current version and zero or more noncurrent versions). Amazon S3 provides\n predefined actions that you can specify for current and noncurrent object\n versions.
\nFor more information, see Object\n Lifecycle Management and Lifecycle Configuration Elements.
\n\n Permissions\n
\nBy default, all Amazon S3 resources are private, including buckets, objects, and related\n subresources (for example, lifecycle configuration and website configuration). Only the\n resource owner (that is, the Amazon Web Services account that created it) can access the resource. The\n resource owner can optionally grant access permissions to others by writing an access\n policy. For this operation, a user must get the s3:PutLifecycleConfiguration\n permission.
You can also explicitly deny permissions. Explicit deny also supersedes any other\n permissions. If you want to block users or accounts from removing or deleting objects from\n your bucket, you must deny them permissions for the following actions:
\n\n s3:DeleteObject\n
\n s3:DeleteObjectVersion\n
\n s3:PutLifecycleConfiguration\n
For more information about permissions, see Managing Access Permissions to Your Amazon S3\n Resources.
\nThe following are related to PutBucketLifecycleConfiguration:
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. Keep in mind that this will overwrite an existing lifecycle configuration,\n so if you want to retain any configuration details, they must be included in the new\n lifecycle configuration. For information about lifecycle configuration, see Managing\n your storage lifecycle.
\nBucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The previous version of the API supported\n filtering based only on an object key name prefix, which is supported for backward\n compatibility. For the related API description, see PutBucketLifecycle.
\nYou specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle\n configuration can have up to 1,000 rules. This limit is not adjustable. Each rule consists\n of the following:
\nFilter identifying a subset of objects to which the rule applies. The filter can\n be based on a key name prefix, object tags, or a combination of both.
\nStatus whether the rule is in effect.
\nOne or more lifecycle transition and expiration actions that you want Amazon S3 to\n perform on the objects identified by the filter. If the state of your bucket is\n versioning-enabled or versioning-suspended, you can have many versions of the same\n object (one current version and zero or more noncurrent versions). Amazon S3 provides\n predefined actions that you can specify for current and noncurrent object\n versions.
\nFor more information, see Object Lifecycle Management\n and Lifecycle Configuration Elements.
\nBy default, all Amazon S3 resources are private, including buckets, objects, and related\n subresources (for example, lifecycle configuration and website configuration). Only the\n resource owner (that is, the Amazon Web Services account that created it) can access the resource. The\n resource owner can optionally grant access permissions to others by writing an access\n policy. For this operation, a user must get the s3:PutLifecycleConfiguration\n permission.
You can also explicitly deny permissions. Explicit deny also supersedes any other\n permissions. If you want to block users or accounts from removing or deleting objects from\n your bucket, you must deny them permissions for the following actions:
\n\n s3:DeleteObject\n
\n s3:DeleteObjectVersion\n
\n s3:PutLifecycleConfiguration\n
For more information about permissions, see Managing Access Permissions to\n Your Amazon S3 Resources.
\nThe following operations are related to PutBucketLifecycleConfiguration:
Set the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as the\n source bucket. To set the logging status of a bucket, you must be the bucket owner.
\nThe bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The\n Permissions request element specifies the kind of access the grantee has to\n the logs.
If the target bucket for log delivery uses the bucket owner enforced\n setting for S3 Object Ownership, you can't use the Grantee request element\n to grant access to others. Permissions can only be granted using policies. For more information, see Permissions for server access log delivery in the\n Amazon S3 User Guide.
\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request.
\nBy Email address:
\n\n \n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nBy URI:
\n\n
To enable logging, you use LoggingEnabled and its children request elements. To disable\n logging, you use an empty BucketLoggingStatus request element:
\n\n
For more information about server access logging, see Server Access Logging in the Amazon S3 User Guide.
\nFor more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.
\nThe following operations are related to PutBucketLogging:
\n PutObject\n
\n\n DeleteBucket\n
\n\n CreateBucket\n
\n\n GetBucketLogging\n
\nSet the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same Amazon Web Services Region as\n the source bucket. To set the logging status of a bucket, you must be the bucket\n owner.
\nThe bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee request element to grant access to other people. The\n Permissions request element specifies the kind of access the grantee has to\n the logs.
If the target bucket for log delivery uses the bucket owner enforced setting for S3\n Object Ownership, you can't use the Grantee request element to grant access\n to others. Permissions can only be granted using policies. For more information, see\n Permissions for server access log delivery in the\n Amazon S3 User Guide.
You can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request.
\nBy Email address:
\n\n \n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nBy URI:
\n\n
To enable logging, you use LoggingEnabled and its children request elements. To disable\n logging, you use an empty BucketLoggingStatus request element:
\n\n
For more information about server access logging, see Server Access Logging in the\n Amazon S3 User Guide.
\nFor more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.
\nThe following operations are related to PutBucketLogging:
\n PutObject\n
\n\n DeleteBucket\n
\n\n CreateBucket\n
\n\n GetBucketLogging\n
\nSets a metrics configuration (specified by the metrics configuration ID) for the bucket.\n You can have up to 1,000 metrics configurations per bucket. If you're updating an existing\n metrics configuration, note that this is a full replacement of the existing metrics\n configuration. If you don't include the elements you want to keep, they are erased.
\nTo use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon\n CloudWatch.
\nThe following operations are related to\n PutBucketMetricsConfiguration:
\n GetBucketLifecycle has the following special error:
Error code: TooManyConfigurations\n
Description: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.
\nHTTP Status Code: HTTP 400 Bad Request
\nSets a metrics configuration (specified by the metrics configuration ID) for the bucket.\n You can have up to 1,000 metrics configurations per bucket. If you're updating an existing\n metrics configuration, note that this is a full replacement of the existing metrics\n configuration. If you don't include the elements you want to keep, they are erased.
\nTo use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring\n Metrics with Amazon CloudWatch.
\nThe following operations are related to\n PutBucketMetricsConfiguration:
\n GetBucketLifecycle has the following special error:
Error code: TooManyConfigurations\n
Description: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.
\nHTTP Status Code: HTTP 400 Bad Request
\nThe ID used to identify the metrics configuration.
", + "smithy.api#documentation": "The ID used to identify the metrics configuration. The ID has a 64 character limit and\n can only contain letters, numbers, periods, dashes, and underscores.
", "smithy.api#httpQuery": "id", "smithy.api#required": {} } @@ -30347,7 +30347,7 @@ "target": "smithy.api#Unit" }, "traits": { - "smithy.api#documentation": "Enables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.
\nUsing this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.
\nBy default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration.
\n
\n \n
This action replaces the existing notification configuration with the configuration\n you include in the request body.
\nAfter Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3\n Events.
\nYou can disable notifications by adding the empty NotificationConfiguration\n element.
\nFor more information about the number of event notification configurations that you can create per bucket, see\n Amazon S3 service quotas in Amazon Web Services General Reference.
\nBy default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with s3:PutBucketNotification permission.
The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add\n the configuration to your bucket.
\n\n Responses\n
\nIf the configuration in the request body includes only one\n TopicConfiguration specifying only the\n s3:ReducedRedundancyLostObject event type, the response will also include\n the x-amz-sns-test-message-id header containing the message ID of the test\n notification sent to the topic.
The following action is related to\n PutBucketNotificationConfiguration:
Enables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.
\nUsing this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.
\nBy default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration.
\n
\n \n
This action replaces the existing notification configuration with the configuration you\n include in the request body.
\nAfter Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3 Events.
\nYou can disable notifications by adding the empty NotificationConfiguration\n element.
\nFor more information about the number of event notification configurations that you can\n create per bucket, see Amazon S3 service quotas in Amazon Web Services\n General Reference.
\nBy default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with s3:PutBucketNotification permission.
The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the\n configuration to your bucket.
\nIf the configuration in the request body includes only one\n TopicConfiguration specifying only the\n s3:ReducedRedundancyLostObject event type, the response will also include\n the x-amz-sns-test-message-id header containing the message ID of the test\n notification sent to the topic.
The following action is related to\n PutBucketNotificationConfiguration:
Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.
", + "smithy.api#documentation": "Skips validation of Amazon SQS, Amazon SNS, and Lambda\n destinations. True or false value.
", "smithy.api#httpHeader": "x-amz-skip-destination-validation" } } @@ -30409,7 +30409,7 @@ "aws.protocols#httpChecksum": { "requestChecksumRequired": true }, - "smithy.api#documentation": "Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketOwnershipControls permission. For\n more information about Amazon S3 permissions, see Specifying permissions in a policy.
For information about Amazon S3 Object Ownership, see Using object ownership.
\nThe following operations are related to PutBucketOwnershipControls:
Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketOwnershipControls permission. For\n more information about Amazon S3 permissions, see Specifying permissions in a\n policy.
For information about Amazon S3 Object Ownership, see Using object\n ownership.
\nThe following operations are related to PutBucketOwnershipControls:
The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that you want\n to apply to this Amazon S3 bucket.
The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or\n ObjectWriter) that you want to apply to this Amazon S3 bucket.
Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than\n the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n PutBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.
As a security precaution, the root user of the Amazon Web Services account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.
\nFor more information, see Bucket policy examples.
\nThe following operations are related to PutBucketPolicy:
\n CreateBucket\n
\n\n DeleteBucket\n
\nApplies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than\n the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the\n PutBucketPolicy permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403\n Access Denied error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed error.
To ensure that bucket owners don't inadvertently lock themselves out of their own\n buckets, the root principal in a bucket owner's Amazon Web Services account can perform the\n GetBucketPolicy, PutBucketPolicy, and\n DeleteBucketPolicy API actions, even if their bucket policy explicitly\n denies the root principal's access. Bucket owner root principals can only be blocked from performing \n these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.
For more information, see Bucket policy\n examples.
\nThe following operations are related to PutBucketPolicy:
\n CreateBucket\n
\n\n DeleteBucket\n
\nCreates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 User Guide.
\nSpecify the replication configuration in the request body. In the replication\n configuration, you provide the name of the destination bucket or buckets where you want\n Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your\n behalf, and other relevant information.
\nA replication configuration must include at least one rule, and can contain a maximum of\n 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in\n the source bucket. To choose additional subsets of objects to replicate, add a rule for\n each subset.
\nTo specify a subset of the objects in the source bucket to apply a replication rule to,\n add the Filter element as a child of the Rule element. You can filter objects based on an\n object key prefix, one or more object tags, or both. When you add the Filter element in the\n configuration, you must also add the following elements:\n DeleteMarkerReplication, Status, and\n Priority.
If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.
\nFor information about enabling versioning on a bucket, see Using Versioning.
\n\n Handling Replication of Encrypted Objects\n
\nBy default, Amazon S3 doesn't replicate objects that are stored at rest using server-side\n encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the\n following: SourceSelectionCriteria, SseKmsEncryptedObjects,\n Status, EncryptionConfiguration, and\n ReplicaKmsKeyID. For information about replication configuration, see\n Replicating Objects\n Created with SSE Using KMS keys.
For information on PutBucketReplication errors, see List of\n replication-related error codes\n
\n Permissions\n
\nTo create a PutBucketReplication request, you must have s3:PutReplicationConfiguration \n permissions for the bucket. \n
By default, a resource owner, in this case the Amazon Web Services account that created the bucket, can\n perform this operation. The resource owner can also grant others permissions to perform the\n operation. For more information about permissions, see Specifying Permissions in a Policy\n and Managing Access Permissions to Your\n Amazon S3 Resources.
\nTo perform this operation, the user or role performing the action must have the\n iam:PassRole permission.
\nThe following operations are related to PutBucketReplication:
\n GetBucketReplication\n
\nCreates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 User Guide.
\nSpecify the replication configuration in the request body. In the replication\n configuration, you provide the name of the destination bucket or buckets where you want\n Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your\n behalf, and other relevant information.
\nA replication configuration must include at least one rule, and can contain a maximum of\n 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in\n the source bucket. To choose additional subsets of objects to replicate, add a rule for\n each subset.
\nTo specify a subset of the objects in the source bucket to apply a replication rule to,\n add the Filter element as a child of the Rule element. You can filter objects based on an\n object key prefix, one or more object tags, or both. When you add the Filter element in the\n configuration, you must also add the following elements:\n DeleteMarkerReplication, Status, and\n Priority.
If you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.
\nFor information about enabling versioning on a bucket, see Using Versioning.
\nBy default, Amazon S3 doesn't replicate objects that are stored at rest using server-side\n encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following:\n SourceSelectionCriteria, SseKmsEncryptedObjects,\n Status, EncryptionConfiguration, and\n ReplicaKmsKeyID. For information about replication configuration, see\n Replicating Objects\n Created with SSE Using KMS keys.
For information on PutBucketReplication errors, see List of\n replication-related error codes\n
To create a PutBucketReplication request, you must have\n s3:PutReplicationConfiguration permissions for the bucket.\n \n
By default, a resource owner, in this case the Amazon Web Services account that created the bucket,\n can perform this operation. The resource owner can also grant others permissions to perform\n the operation. For more information about permissions, see Specifying Permissions in a\n Policy and Managing Access Permissions to\n Your Amazon S3 Resources.
\nTo perform this operation, the user or role performing the action must have the\n iam:PassRole permission.
\nThe following operations are related to PutBucketReplication:
\n GetBucketReplication\n
\nSets the request payment configuration for a bucket. By default, the bucket owner pays\n for downloads from the bucket. This configuration parameter enables the bucket owner (only)\n to specify that the person requesting the download will be charged for the download. For\n more information, see Requester Pays\n Buckets.
\nThe following operations are related to PutBucketRequestPayment:
\n CreateBucket\n
\nSets the request payment configuration for a bucket. By default, the bucket owner pays\n for downloads from the bucket. This configuration parameter enables the bucket owner (only)\n to specify that the person requesting the download will be charged for the download. For\n more information, see Requester Pays\n Buckets.
\nThe following operations are related to PutBucketRequestPayment:
\n CreateBucket\n
\nThe base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n message integrity check to verify that the request body was not corrupted in transit. For\n more information, see RFC\n 1864.
\nFor requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
", + "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.
\nFor requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
", "smithy.api#httpHeader": "Content-MD5" } }, @@ -30695,7 +30695,7 @@ "requestAlgorithmMember": "ChecksumAlgorithm", "requestChecksumRequired": true }, - "smithy.api#documentation": "Sets the tags for a bucket.
\nUse tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign\n up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of\n combined resources, organize your billing information according to resources with the same\n tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost Allocation\n and Tagging and Using Cost Allocation in Amazon S3 Bucket\n Tags.
\n\n When this operation sets the tags for a bucket, it will overwrite any current tags the \n bucket already has. You cannot use this operation to add tags to an existing list of tags.
\nTo use this operation, you must have permissions to perform the\n s3:PutBucketTagging action. The bucket owner has this permission by default\n 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\n Resources.
\n PutBucketTagging has the following special errors:
Error code: InvalidTagError\n
Description: The tag provided was not a valid tag. This error can occur if\n the tag did not pass input validation. For information about tag restrictions,\n see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions.
\nError code: MalformedXMLError\n
Description: The XML provided does not match the schema.
\nError code: OperationAbortedError \n
Description: A conflicting conditional action is currently in progress\n against this resource. Please try again.
\nError code: InternalError\n
Description: The service was unable to apply the provided tag to the\n bucket.
\nThe following operations are related to PutBucketTagging:
\n GetBucketTagging\n
\n\n DeleteBucketTagging\n
\nSets the tags for a bucket.
\nUse tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this,\n sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost\n of combined resources, organize your billing information according to resources with the\n same tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost Allocation and\n Tagging and Using Cost Allocation in Amazon S3 Bucket\n Tags.
\nWhen this operation sets the tags for a bucket, it will overwrite any current tags\n the bucket already has. You cannot use this operation to add tags to an existing list of\n tags.
\nTo use this operation, you must have permissions to perform the\n s3:PutBucketTagging action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
\n PutBucketTagging has the following special errors:
Error code: InvalidTagError\n
Description: The tag provided was not a valid tag. This error can occur if\n the tag did not pass input validation. For information about tag restrictions,\n see User-Defined Tag Restrictions and Amazon Web Services-Generated Cost Allocation Tag Restrictions.
\nError code: MalformedXMLError\n
Description: The XML provided does not match the schema.
\nError code: OperationAbortedError \n
Description: A conflicting conditional action is currently in progress\n against this resource. Please try again.
\nError code: InternalError\n
Description: The service was unable to apply the provided tag to the\n bucket.
\nThe following operations are related to PutBucketTagging:
\n GetBucketTagging\n
\n\n DeleteBucketTagging\n
\nSets the versioning state of an existing bucket.
\nYou can set the versioning state with one of the following values:
\n\n Enabled—Enables versioning for the objects in the\n bucket. All objects added to the bucket receive a unique version ID.
\n\n Suspended—Disables versioning for the objects in the\n bucket. All objects added to the bucket receive the version ID null.
\nIf the versioning state has never been set on a bucket, it has no versioning state; a\n GetBucketVersioning request does not return a versioning state value.
\nIn order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner\n and want to enable MFA Delete in the bucket versioning configuration, you must\n include the x-amz-mfa request header and the\n Status and the MfaDelete request elements in a request to set\n the versioning state of the bucket.
If you have an object expiration lifecycle policy in your non-versioned bucket and\n you want to maintain the same permanent delete behavior when you enable versioning, you\n must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will\n manage the deletes of the noncurrent object versions in the version-enabled bucket. (A\n version-enabled bucket maintains one current and zero or more noncurrent object\n versions.) For more information, see Lifecycle and Versioning.
\n\n Related Resources\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetBucketVersioning\n
\nSets the versioning state of an existing bucket.
\nYou can set the versioning state with one of the following values:
\n\n Enabled—Enables versioning for the objects in the\n bucket. All objects added to the bucket receive a unique version ID.
\n\n Suspended—Disables versioning for the objects in the\n bucket. All objects added to the bucket receive the version ID null.
\nIf the versioning state has never been set on a bucket, it has no versioning state; a\n GetBucketVersioning request does not return a versioning state value.
\nIn order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner\n and want to enable MFA Delete in the bucket versioning configuration, you must include the\n x-amz-mfa request header and the Status and the\n MfaDelete request elements in a request to set the versioning state of the\n bucket.
If you have an object expiration lifecycle configuration in your non-versioned bucket and\n you want to maintain the same permanent delete behavior when you enable versioning, you\n must add a noncurrent expiration policy. The noncurrent expiration lifecycle configuration will\n manage the deletes of the noncurrent object versions in the version-enabled bucket. (A\n version-enabled bucket maintains one current and zero or more noncurrent object\n versions.) For more information, see Lifecycle and Versioning.
\nThe following operations are related to PutBucketVersioning:
\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetBucketVersioning\n
\nAdds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.
\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket.
\nAmazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object\n locking; if you need this, make sure to build it into your application layer or use\n versioning instead.
\nTo ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.
To successfully complete the PutObject request, you must have the \n s3:PutObject in your IAM permissions.
To successfully change the objects acl of your PutObject request, \n you must have the s3:PutObjectAcl in your IAM permissions.
The Content-MD5 header is required for any request to upload an object\n with a retention period configured using Amazon S3 Object Lock. For more information about\n Amazon S3 Object Lock, see Amazon S3 Object Lock Overview\n in the Amazon S3 User Guide.
\n Server-side Encryption\n
\nYou can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts \n your data as it writes it to disks in its data centers and decrypts the data\n when you access it. You have the option to provide your own encryption key or use Amazon Web Services\n managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side\n Encryption.
\nIf you request server-side encryption using Amazon Web Services Key Management Service (SSE-KMS), you can enable \n an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys in the \n Amazon S3 User Guide.
\n\n Access Control List (ACL)-Specific Request\n Headers\n
\nYou can use headers to grant ACL- based permissions. By default, all objects are\n private. Only the owner has full access control. When adding a new object, you can grant\n permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These\n permissions are then added to the ACL on the object. For more information, see Access Control List\n (ACL) Overview and Managing ACLs Using the REST\n API.
\nIf the bucket that you're uploading objects to uses the bucket owner enforced setting\n for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control canned\n ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other\n ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a\n 400 error with the error code\n AccessControlListNotSupported.
For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for Object Ownership, \n all objects written to the bucket by any account will be owned by the bucket owner.
\n\n Storage Class Options\n
\nBy default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
\n\n Versioning\n
\nIf you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects.
\nFor more information about versioning, see Adding Objects to\n Versioning Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\n\n Related Resources\n
\n\n CopyObject\n
\n\n DeleteObject\n
\nAdds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.
\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket. You cannot use PutObject to only update a\n single piece of metadata for an existing object. You must put the entire object with\n updated metadata if you want to update some values.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. To prevent objects from\n being deleted or overwritten, you can use Amazon S3 Object\n Lock.
\nTo ensure that data is not corrupted traversing the network, use the\n Content-MD5 header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.
To successfully complete the PutObject request, you must have the\n s3:PutObject in your IAM permissions.
To successfully change the objects acl of your PutObject request,\n you must have the s3:PutObjectAcl in your IAM permissions.
To successfully set the tag-set with your PutObject request, you\n must have the s3:PutObjectTagging in your IAM permissions.
The Content-MD5 header is required for any request to upload an\n object with a retention period configured using Amazon S3 Object Lock. For more\n information about Amazon S3 Object Lock, see Amazon S3 Object Lock\n Overview in the Amazon S3 User Guide.
You have three mutually exclusive options to protect data using server-side encryption\n in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the\n encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and\n customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using\n Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at by\n rest using server-side encryption with other key options. For more information, see Using\n Server-Side Encryption.
\nWhen adding a new object, you can use headers to grant ACL-based permissions to\n individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are\n then added to the ACL on the object. By default, all objects are private. Only the owner\n has full access control. For more information, see Access Control List (ACL) Overview\n and Managing\n ACLs Using the REST API.
\nIf the bucket that you're uploading objects to uses the bucket owner enforced setting\n for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that\n use this setting only accept PUT requests that don't specify an ACL or PUT requests that\n specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that\n contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a\n 400 error with the error code AccessControlListNotSupported.\n For more information, see Controlling ownership of\n objects and disabling ACLs in the Amazon S3 User Guide.
If your bucket uses the bucket owner enforced setting for Object Ownership, all\n objects written to the bucket by any account will be owned by the bucket owner.
\nBy default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
\nIf you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects. For more information about versioning, see\n Adding Objects to\n Versioning-Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\nFor more information about related Amazon S3 APIs, see the following:
\n\n CopyObject\n
\n\n DeleteObject\n
\nUses the acl subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have WRITE_ACP\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon S3 User Guide.
This action is not supported by Amazon S3 on Outposts.
\nDepending on your application needs, you can choose to set\n the ACL on an object using either the request body or the headers. For example, if you have\n an existing application that updates a bucket ACL using the request body, you can continue\n to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. \n You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and \n return the AccessControlListNotSupported error code. Requests to read ACLs are still supported.\n For more information, see Controlling object ownership\n in the Amazon S3 User Guide.
\n Access Permissions\n
\nYou can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set\n of grantees and permissions. Specify the canned ACL name as the value of\n x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n x-amz-acl header to set a canned ACL. These parameters map to the set\n of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)\n Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read header grants list\n objects permission to the two Amazon Web Services accounts identified by their email\n addresses.
\n x-amz-grant-read: emailAddress=\"xyz@amazon.com\",\n emailAddress=\"abc@amazon.com\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\n\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request.
\nBy URI:
\n\n
By Email address:
\n\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\n\n Versioning\n
\nThe ACL of an object is set at the object version level. By default, PUT sets the ACL of\n the current version of an object. To set the ACL of a different version, use the\n versionId subresource.
\n Related Resources\n
\n\n CopyObject\n
\n\n GetObject\n
\nUses the acl subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have WRITE_ACP\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon S3 User Guide.
This action is not supported by Amazon S3 on Outposts.
\nDepending on your application needs, you can choose to set the ACL on an object using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, you can continue to use that approach.\n For more information, see Access Control List (ACL) Overview\n in the Amazon S3 User Guide.
\nIf your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs\n are disabled and no longer affect permissions. You must use policies to grant access to\n your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return\n the AccessControlListNotSupported error code. Requests to read ACLs are\n still supported. For more information, see Controlling object\n ownership in the Amazon S3 User Guide.
You can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set\n of grantees and permissions. Specify the canned ACL name as the value of\n x-amz-acl. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned\n ACL.
Specify access permissions explicitly with the x-amz-grant-read,\n x-amz-grant-read-acp, x-amz-grant-write-acp, and\n x-amz-grant-full-control headers. When using these headers, you\n specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n x-amz-acl header to set a canned ACL. These parameters map to the set\n of permissions that Amazon S3 supports in an ACL. For more information, see Access Control\n List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an\n Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read header grants list\n objects permission to the two Amazon Web Services accounts identified by their email\n addresses.
\n x-amz-grant-read: emailAddress=\"xyz@amazon.com\",\n emailAddress=\"abc@amazon.com\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
DisplayName is optional and ignored in the request.
\nBy URI:
\n\n
By Email address:
\n\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nThe ACL of an object is set at the object version level. By default, PUT sets the ACL of\n the current version of an object. To set the ACL of a different version, use the\n versionId subresource.
The following operations are related to PutObjectAcl:
\n CopyObject\n
\n\n GetObject\n
\nThe canned ACL to apply to the object. For more information, see Canned ACL.
", + "smithy.api#documentation": "The canned ACL to apply to the object. For more information, see Canned\n ACL.
", "smithy.api#httpHeader": "x-amz-acl" } }, @@ -31012,7 +31012,7 @@ "GrantRead": { "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "Allows grantee to list the objects in the\n bucket.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Allows grantee to list the objects in the bucket.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-read" } }, @@ -31026,21 +31026,21 @@ "GrantWrite": { "target": "com.amazonaws.s3#GrantWrite", "traits": { - "smithy.api#documentation": "Allows grantee to create new objects in the bucket.
\nFor the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
", + "smithy.api#documentation": "Allows grantee to create new objects in the bucket.
\nFor the bucket and object owners of existing objects, also allows deletions and\n overwrites of those objects.
", "smithy.api#httpHeader": "x-amz-grant-write" } }, "GrantWriteACP": { "target": "com.amazonaws.s3#GrantWriteACP", "traits": { - "smithy.api#documentation": "Allows grantee to write the ACL for the applicable\n bucket.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Allows grantee to write the ACL for the applicable bucket.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, "Key": { "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "Key for which the PUT action was initiated.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
Key for which the PUT action was initiated.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Places an Object Lock configuration on the specified bucket. The rule specified in the\n Object Lock configuration will be applied by default to every new object placed in the\n specified bucket. For more information, see Locking Objects.\n
\nThe DefaultRetention settings require both a mode and a\n period.
The DefaultRetention period can be either Days\n or Years but you must select one. You cannot specify Days\n and Years at the same time.
You can only enable Object Lock for new buckets. If you want to turn on\n Object Lock for an existing bucket, contact Amazon Web Services Support.
\nPlaces an Object Lock configuration on the specified bucket. The rule specified in the\n Object Lock configuration will be applied by default to every new object placed in the\n specified bucket. For more information, see Locking Objects.
\nThe DefaultRetention settings require both a mode and a\n period.
The DefaultRetention period can be either Days or\n Years but you must select one. You cannot specify\n Days and Years at the same time.
You can only enable Object Lock for new buckets. If you want to turn on Object\n Lock for an existing bucket, contact Amazon Web Services Support.
\nIf you specified server-side encryption either with an Amazon Web Services KMS key\n or Amazon S3-managed encryption key in your PUT request, the response includes this header. It\n confirms the encryption algorithm that Amazon S3 used to encrypt the object.
", + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
If x-amz-server-side-encryption is present and has the value of\n aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service\n (Amazon Web Services KMS) symmetric customer managed key that was used for the\n object.
If x-amz-server-side-encryption is has a valid value of\n aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service\n (Amazon Web Services KMS) symmetric encryption customer managed key that was used for the object.
If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.
", + "smithy.api#documentation": "If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs. This value is stored as object metadata and automatically gets passed\n on to Amazon Web Services KMS for future GetObject or CopyObject operations on\n this object.
Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption\n with Amazon Web Services KMS (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -31382,7 +31382,7 @@ "ACL": { "target": "com.amazonaws.s3#ObjectCannedACL", "traits": { - "smithy.api#documentation": "The canned ACL to apply to the object. For more information, see Canned\n ACL.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "The canned ACL to apply to the object. For more information, see Canned\n ACL.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-acl" } }, @@ -31397,7 +31397,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The bucket name to which the PUT action was initiated.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The bucket name to which the PUT action was initiated.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.
", + "smithy.api#documentation": "Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
", "smithy.api#httpHeader": "Content-Disposition" } }, "ContentEncoding": { "target": "com.amazonaws.s3#ContentEncoding", "traits": { - "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
", + "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding.
", "smithy.api#httpHeader": "Content-Encoding" } }, @@ -31437,21 +31437,21 @@ "target": "com.amazonaws.s3#ContentLength", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "Size of the body in bytes. This parameter is useful when the size of the body cannot be\n determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.
", + "smithy.api#documentation": "Size of the body in bytes. This parameter is useful when the size of the body cannot be\n determined automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.
", "smithy.api#httpHeader": "Content-Length" } }, "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the message (without the headers) according to\n RFC 1864. This header can be used as a message integrity check to verify that the data is\n the same data that was originally sent. Although it is optional, we recommend using the\n Content-MD5 mechanism as an end-to-end integrity check. For more information about REST\n request authentication, see REST\n Authentication.
", + "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the message (without the headers) according to\n RFC 1864. This header can be used as a message integrity check to verify that the data is\n the same data that was originally sent. Although it is optional, we recommend using the\n Content-MD5 mechanism as an end-to-end integrity check. For more information about REST\n request authentication, see REST Authentication.
", "smithy.api#httpHeader": "Content-MD5" } }, "ContentType": { "target": "com.amazonaws.s3#ContentType", "traits": { - "smithy.api#documentation": "A standard MIME type describing the format of the contents. For more information, see\n http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.
", + "smithy.api#documentation": "A standard MIME type describing the format of the contents. For more information, see\n https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.
", "smithy.api#httpHeader": "Content-Type" } }, @@ -31493,21 +31493,21 @@ "Expires": { "target": "com.amazonaws.s3#Expires", "traits": { - "smithy.api#documentation": "The date and time at which the object is no longer cacheable. For more information, see\n http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.
", + "smithy.api#documentation": "The date and time at which the object is no longer cacheable. For more information, see\n https://www.rfc-editor.org/rfc/rfc7234#section-5.3.
", "smithy.api#httpHeader": "Expires" } }, "GrantFullControl": { "target": "com.amazonaws.s3#GrantFullControl", "traits": { - "smithy.api#documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-full-control" } }, "GrantRead": { "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "Allows grantee to read the object data and its\n metadata.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Allows grantee to read the object data and its metadata.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-read" } }, @@ -31521,7 +31521,7 @@ "GrantWriteACP": { "target": "com.amazonaws.s3#GrantWriteACP", "traits": { - "smithy.api#documentation": "Allows grantee to write the ACL for the applicable\n object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Allows grantee to write the ACL for the applicable object.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, @@ -31543,21 +31543,21 @@ "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
", + "smithy.api#documentation": "By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the\n Amazon S3 User Guide.
", "smithy.api#httpHeader": "x-amz-storage-class" } }, "WebsiteRedirectLocation": { "target": "com.amazonaws.s3#WebsiteRedirectLocation", "traits": { - "smithy.api#documentation": "If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata. For information about object metadata, see Object Key and Metadata.
\nIn the following example, the request header sets the redirect to an object\n (anotherPage.html) in the same bucket:
\n\n x-amz-website-redirect-location: /anotherPage.html\n
In the following example, the request header sets the object redirect to another\n website:
\n\n x-amz-website-redirect-location: http://www.example.com/\n
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page\n Redirects.
", + "smithy.api#documentation": "If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata. For information about object metadata, see Object Key and Metadata.
\nIn the following example, the request header sets the redirect to an object\n (anotherPage.html) in the same bucket:
\n\n x-amz-website-redirect-location: /anotherPage.html\n
In the following example, the request header sets the object redirect to another\n website:
\n\n x-amz-website-redirect-location: http://www.example.com/\n
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and\n How to\n Configure Website Page Redirects.
", "smithy.api#httpHeader": "x-amz-website-redirect-location" } }, @@ -31585,14 +31585,14 @@ "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "If x-amz-server-side-encryption is present and has the value of\n aws:kms, this header specifies the ID of the Amazon Web Services Key Management Service\n (Amazon Web Services KMS) symmetrical customer managed key that was used for the\n object. If you specify x-amz-server-side-encryption:aws:kms, but do not\n provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services\n managed key to protect the data. If the KMS key does not exist in the same account\n issuing the command, you must use the full ARN and not just the ID.\n
If x-amz-server-side-encryption has a valid value of aws:kms,\n this header specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object. If you specify\n x-amz-server-side-encryption:aws:kms, but do not provide\n x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key to\n protect the data. If the KMS key does not exist in the same account issuing the command,\n you must use the full ARN and not just the ID.
Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.
", + "smithy.api#documentation": "Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of\n this header is a base64-encoded UTF-8 string holding JSON with the encryption context\n key-value pairs. This value is stored as object metadata and automatically gets passed on to\n Amazon Web Services KMS for future GetObject or CopyObject operations on this\n object.
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with a PUT action doesn’t affect bucket-level settings for S3 Bucket Key.
", + "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with\n server-side encryption using AWS KMS (SSE-KMS). Setting this header to true\n causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with a PUT action doesn’t affect bucket-level settings for S3\n Bucket Key.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -31634,7 +31634,7 @@ "ObjectLockLegalHoldStatus": { "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", "traits": { - "smithy.api#documentation": "Specifies whether a legal hold will be applied to this object. For more information\n about S3 Object Lock, see Object\n Lock.
", + "smithy.api#documentation": "Specifies whether a legal hold will be applied to this object. For more information\n about S3 Object Lock, see Object Lock.
", "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" } }, @@ -31663,7 +31663,7 @@ "requestAlgorithmMember": "ChecksumAlgorithm", "requestChecksumRequired": true }, - "smithy.api#documentation": "Places an Object Retention configuration on an object. For more information, see Locking Objects.\n Users or accounts require the s3:PutObjectRetention permission in order to place\n an Object Retention configuration on objects. Bypassing a Governance Retention configuration\n requires the s3:BypassGovernanceRetention permission.\n
This action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Places an Object Retention configuration on an object. For more information, see Locking Objects.\n Users or accounts require the s3:PutObjectRetention permission in order to\n place an Object Retention configuration on objects. Bypassing a Governance Retention\n configuration requires the s3:BypassGovernanceRetention permission.
This action is not supported by Amazon S3 on Outposts.
", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?retention", @@ -31775,7 +31775,7 @@ "requestAlgorithmMember": "ChecksumAlgorithm", "requestChecksumRequired": true }, - "smithy.api#documentation": "Sets the supplied tag-set to an object that already exists in a bucket.
\nA tag is a key-value pair. You can associate tags with an object by sending a PUT\n request against the tagging subresource that is associated with the object. You can\n retrieve tags by sending a GET request. For more information, see GetObjectTagging.
\nFor tagging-related restrictions related to characters and encodings, see Tag\n Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per\n object.
\nTo use this operation, you must have permission to perform the\n s3:PutObjectTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.
To put tags of any other version, use the versionId query parameter. You\n also need permission for the s3:PutObjectVersionTagging action.
For information about the Amazon S3 object tagging feature, see Object Tagging.
\n\n Special Errors\n
\n\n Code: InvalidTagError \n
\n\n Cause: The tag provided was not a valid tag. This error can occur\n if the tag did not pass input validation. For more information, see Object Tagging.\n
\n\n Code: MalformedXMLError \n
\n\n Cause: The XML provided does not match the schema.\n
\n\n Code: OperationAbortedError \n
\n\n Cause: A conflicting conditional action is currently in\n progress against this resource. Please try again.\n
\n\n Code: InternalError\n
\n\n Cause: The service was unable to apply the provided tag to the\n object.\n
\n\n Related Resources\n
\n\n GetObjectTagging\n
\n\n DeleteObjectTagging\n
\nSets the supplied tag-set to an object that already exists in a bucket.
\nA tag is a key-value pair. You can associate tags with an object by sending a PUT\n request against the tagging subresource that is associated with the object. You can\n retrieve tags by sending a GET request. For more information, see GetObjectTagging.
\nFor tagging-related restrictions related to characters and encodings, see Tag\n Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per\n object.
\nTo use this operation, you must have permission to perform the\n s3:PutObjectTagging action. By default, the bucket owner has this\n permission and can grant this permission to others.
To put tags of any other version, use the versionId query parameter. You\n also need permission for the s3:PutObjectVersionTagging action.
For information about the Amazon S3 object tagging feature, see Object Tagging.
\n\n PutObjectTagging has the following special errors:
\n Code: InvalidTagError \n
\n\n Cause: The tag provided was not a valid tag. This error can occur\n if the tag did not pass input validation. For more information, see Object\n Tagging.\n
\n\n Code: MalformedXMLError \n
\n\n Cause: The XML provided does not match the schema.\n
\n\n Code: OperationAbortedError \n
\n\n Cause: A conflicting conditional action is currently in progress\n against this resource. Please try again.\n
\n\n Code: InternalError\n
\n\n Cause: The service was unable to apply the provided tag to the\n object.\n
\nThe following operations are related to PutObjectTagging:
\n GetObjectTagging\n
\n\n DeleteObjectTagging\n
\nThe bucket name containing the object.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The bucket name containing the object.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Creates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.\n To use this operation, you must have the s3:PutBucketPublicAccessBlock\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or\n an object, it checks the PublicAccessBlock configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock configurations are different between the bucket and\n the account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
\n\n Related Resources\n
\n\n GetPublicAccessBlock\n
\nCreates or modifies the PublicAccessBlock configuration for an Amazon S3 bucket.\n To use this operation, you must have the s3:PutBucketPublicAccessBlock\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or\n an object, it checks the PublicAccessBlock configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock configurations are different between the bucket and\n the account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
\nThe following operations are related to PutPublicAccessBlock:
\n GetPublicAccessBlock\n
\nThe Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that\n Amazon S3 assumes when replicating objects. For more information, see How to Set Up\n Replication in the Amazon S3 User Guide.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that Amazon S3 assumes when\n replicating objects. For more information, see How to Set Up Replication\n in the Amazon S3 User Guide.
", "smithy.api#required": {} } }, @@ -32188,13 +32188,13 @@ "SourceSelectionCriteria": { "target": "com.amazonaws.s3#SourceSelectionCriteria", "traits": { - "smithy.api#documentation": "A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer managed key stored in Amazon Web Services Key Management\n Service (SSE-KMS).
" + "smithy.api#documentation": "A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service\n (SSE-KMS).
" } }, "ExistingObjectReplication": { "target": "com.amazonaws.s3#ExistingObjectReplication", "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "Optional configuration to replicate existing source bucket objects. For more\n information, see Replicating Existing Objects in the Amazon S3 User Guide.\n
" } }, "Destination": { @@ -32471,7 +32471,7 @@ "aws.protocols#httpChecksum": { "requestAlgorithmMember": "ChecksumAlgorithm" }, - "smithy.api#documentation": "Restores an archived copy of an object back into Amazon S3
\nThis action is not supported by Amazon S3 on Outposts.
\nThis action performs the following types of requests:
\n\n select - Perform a select query on an archived object
\n restore an archive - Restore an archived object
To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by default\n 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\n Resources in the Amazon S3 User Guide.
\n Querying Archives with Select Requests\n
\nYou use a select type of request to perform SQL queries on archived objects. The\n archived objects that are being queried by the select request must be formatted as\n uncompressed comma-separated values (CSV) files. You can run queries and custom analytics\n on your archived data without having to restore your data to a hotter Amazon S3 tier. For an\n overview about select requests, see Querying Archived Objects in the Amazon S3 User Guide.
\nWhen making a select request, do the following:
\nDefine an output location for the select query's output. This must be an Amazon S3\n bucket in the same Amazon Web Services Region as the bucket that contains the archive object that is\n being queried. The Amazon Web Services account that initiates the job must have permissions to write\n to the S3 bucket. You can specify the storage class and encryption for the output\n objects stored in the bucket. For more information about output, see Querying Archived Objects\n in the Amazon S3 User Guide.
\nFor more information about the S3 structure in the request body, see\n the following:
\n PutObject\n
\n\n Managing Access with\n ACLs in the Amazon S3 User Guide\n
\n\n Protecting Data Using\n Server-Side Encryption in the\n Amazon S3 User Guide\n
\nDefine the SQL expression for the SELECT type of restoration for your\n query in the request body's SelectParameters structure. You can use\n expressions like the following examples.
The following expression returns all records from the specified\n object.
\n\n SELECT * FROM Object\n
Assuming that you are not using any headers for data stored in the object,\n you can specify columns with positional headers.
\n\n SELECT s._1, s._2 FROM Object s WHERE s._3 > 100\n
If you have headers and you set the fileHeaderInfo in the\n CSV structure in the request body to USE, you can\n specify headers in the query. (If you set the fileHeaderInfo field\n to IGNORE, the first row is skipped for the query.) You cannot mix\n ordinal positions with header column names.
\n SELECT s.Id, s.FirstName, s.SSN FROM S3Object s\n
For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and\n S3 Glacier Select in the Amazon S3 User Guide.
\nWhen making a select request, you can also do the following:
\nTo expedite your queries, specify the Expedited tier. For more\n information about tiers, see \"Restoring Archives,\" later in this topic.
Specify details about the data serialization format of both the input object that\n is being queried and the serialization of the CSV-encoded query results.
\nThe following are additional important facts about the select feature:
\nThe output results are new Amazon S3 objects. Unlike archive retrievals, they are\n stored until explicitly deleted-manually or through a lifecycle policy.
\nYou can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't\n deduplicate requests, so avoid issuing duplicate requests.
\n Amazon S3 accepts a select request even if the object has already been restored. A\n select request doesn’t return error response 409.
\n Restoring objects\n
\nObjects that you archive to the S3 Glacier or\n S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers are not accessible in real time. For objects in\n Archive Access or Deep Archive Access tiers you must first initiate a restore request, and\n then wait until the object is moved into the Frequent Access tier. For objects in\n S3 Glacier or S3 Glacier Deep Archive storage classes you must\n first initiate a restore request, and then wait until a temporary copy of the object is\n available. To access an archived object, you must restore the object for the duration\n (number of days) that you specify.
\nTo restore a specific object version, you can provide a version ID. If you don't provide\n a version ID, Amazon S3 restores the current version.
\nWhen restoring an archived object (or using a select request), you can specify one of\n the following data access tier options in the Tier element of the request\n body:
\n Expedited - Expedited retrievals allow you to quickly access your\n data stored in the S3 Glacier storage class or S3 Intelligent-Tiering Archive\n tier when occasional urgent requests for a subset of archives are required. For all\n but the largest archived objects (250 MB+), data accessed using Expedited retrievals\n is typically made available within 1–5 minutes. Provisioned capacity ensures that\n retrieval capacity for Expedited retrievals is available when you need it. Expedited\n retrievals and provisioned capacity are not available for objects stored in the\n S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.
\n Standard - Standard retrievals allow you to access any of your\n archived objects within several hours. This is the default option for retrieval\n requests that do not specify the retrieval option. Standard retrievals typically\n finish within 3–5 hours for objects stored in the S3 Glacier storage\n class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in\n S3 Intelligent-Tiering.
\n Bulk - Bulk retrievals are the lowest-cost retrieval option in\n S3 Glacier, enabling you to retrieve large amounts, even petabytes, of data\n inexpensively. Bulk retrievals typically finish within 5–12 hours for objects stored\n in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier. They\n typically finish within 48 hours for objects stored in the\n S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Bulk\n retrievals are free for objects stored in S3 Intelligent-Tiering.
For more information about archive retrieval options and provisioned capacity for\n 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\n while it is in progress. For more information, see \n Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.
\nTo get the status of object restoration, you can send a HEAD request.\n Operations return the x-amz-restore header, which provides information about\n the restoration status, in the response. You can use Amazon S3 event notifications to notify you\n when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in\n the Amazon S3 User Guide.
After restoring an archived object, you can update the restoration period by reissuing\n the request with a new period. Amazon S3 updates the restoration period relative to the current\n time and charges only for the request-there are no data transfer charges. You cannot\n update the restoration period when Amazon S3 is actively processing your current restore request\n for the object.
\nIf your bucket has a lifecycle configuration with a rule that includes an expiration\n action, the object expiration overrides the life span that you specify in a restore\n request. For example, if you restore an object copy for 10 days, but the object is\n scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information\n about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in\n Amazon S3 User Guide.
\n\n Responses\n
\nA successful action returns either the 200 OK or 202\n Accepted status code.
If the object is not previously restored, then Amazon S3 returns 202\n Accepted in the response.
If the object is previously restored, Amazon S3 returns 200 OK in the\n response.
\n Special Errors\n
\n\n Code: RestoreAlreadyInProgress\n
\n\n Cause: Object restore is already in progress. (This error does not\n apply to SELECT type requests.)\n
\n\n HTTP Status Code: 409 Conflict\n
\n\n SOAP Fault Code Prefix: Client\n
\n\n Code: GlacierExpeditedRetrievalNotAvailable\n
\n\n Cause: expedited retrievals are currently not available. Try again\n later. (Returned if there is insufficient capacity to process the Expedited\n request. This error applies only to Expedited retrievals and not to\n S3 Standard or Bulk retrievals.)\n
\n\n HTTP Status Code: 503\n
\n\n SOAP Fault Code Prefix: N/A\n
\n\n Related Resources\n
\n\n SQL Reference for\n Amazon S3 Select and S3 Glacier Select in the\n Amazon S3 User Guide\n
\nRestores an archived copy of an object back into Amazon S3
\nThis action is not supported by Amazon S3 on Outposts.
\nThis action performs the following types of requests:
\n\n select - Perform a select query on an archived object
\n restore an archive - Restore an archived object
For more information about the S3 structure in the request body, see the\n following:
\n PutObject\n
\n\n Managing Access with ACLs in the\n Amazon S3 User Guide\n
\n\n Protecting Data Using\n Server-Side Encryption in the\n Amazon S3 User Guide\n
\nDefine the SQL expression for the SELECT type of restoration for your\n query in the request body's SelectParameters structure. You can use\n expressions like the following examples.
The following expression returns all records from the specified\n object.
\n\n SELECT * FROM Object\n
Assuming that you are not using any headers for data stored in the object,\n you can specify columns with positional headers.
\n\n SELECT s._1, s._2 FROM Object s WHERE s._3 > 100\n
If you have headers and you set the fileHeaderInfo in the\n CSV structure in the request body to USE, you can\n specify headers in the query. (If you set the fileHeaderInfo field\n to IGNORE, the first row is skipped for the query.) You cannot mix\n ordinal positions with header column names.
\n SELECT s.Id, s.FirstName, s.SSN FROM S3Object s\n
When making a select request, you can also do the following:
\nTo expedite your queries, specify the Expedited tier. For more\n information about tiers, see \"Restoring Archives,\" later in this topic.
Specify details about the data serialization format of both the input object that\n is being queried and the serialization of the CSV-encoded query results.
\nThe following are additional important facts about the select feature:
\nThe output results are new Amazon S3 objects. Unlike archive retrievals, they are\n stored until explicitly deleted-manually or through a lifecycle configuration.
\nYou can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't\n duplicate requests, so avoid issuing duplicate requests.
\n Amazon S3 accepts a select request even if the object has already been restored. A\n select request doesn’t return error response 409.
To use this operation, you must have permissions to perform the\n s3:RestoreObject action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources in the\n Amazon S3 User Guide.
Objects that you archive to the S3 Glacier Flexible Retrieval or\n S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or\n S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the\n S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive storage\n classes, you must first initiate a restore request, and then wait until a temporary copy of\n the object is available. If you want a permanent copy of the object, create a copy of it in\n the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must\n restore the object for the duration (number of days) that you specify. For objects in the\n Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first\n initiate a restore request, and then wait until the object is moved into the Frequent\n Access tier.
\nTo restore a specific object version, you can provide a version ID. If you don't provide\n a version ID, Amazon S3 restores the current version.
\nWhen restoring an archived object, you can specify one of the following data access tier\n options in the Tier element of the request body:
\n Expedited - Expedited retrievals allow you to quickly access your\n data stored in the S3 Glacier Flexible Retrieval storage class or\n S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives\n are required. For all but the largest archived objects (250 MB+), data accessed using\n Expedited retrievals is typically made available within 1–5 minutes. Provisioned\n capacity ensures that retrieval capacity for Expedited retrievals is available when\n you need it. Expedited retrievals and provisioned capacity are not available for\n objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier.
\n Standard - Standard retrievals allow you to access any of your\n archived objects within several hours. This is the default option for retrieval\n requests that do not specify the retrieval option. Standard retrievals typically\n finish within 3–5 hours for objects stored in the S3 Glacier Flexible\n Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within\n 12 hours for objects stored in the S3 Glacier Deep Archive storage class or\n S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in\n S3 Intelligent-Tiering.
\n Bulk - Bulk retrievals free for objects stored in the S3 Glacier\n Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to\n retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically\n finish within 5–12 hours for objects stored in the S3 Glacier\n Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are\n also the lowest-cost retrieval option when restoring objects from\n S3 Glacier Deep Archive. They typically finish within 48 hours for objects\n stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive\n tier.
For more information about archive retrieval options and provisioned capacity for\n Expedited data access, see Restoring Archived Objects in\n the Amazon S3 User Guide.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed\n while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the\n Amazon S3 User Guide.
\nTo get the status of object restoration, you can send a HEAD request.\n Operations return the x-amz-restore header, which provides information about\n the restoration status, in the response. You can use Amazon S3 event notifications to notify you\n when a restore is initiated or completed. For more information, see Configuring Amazon S3\n Event Notifications in the Amazon S3 User Guide.
After restoring an archived object, you can update the restoration period by reissuing\n the request with a new period. Amazon S3 updates the restoration period relative to the current\n time and charges only for the request-there are no data transfer charges. You cannot\n update the restoration period when Amazon S3 is actively processing your current restore request\n for the object.
\nIf your bucket has a lifecycle configuration with a rule that includes an expiration\n action, the object expiration overrides the life span that you specify in a restore\n request. For example, if you restore an object copy for 10 days, but the object is\n scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information\n about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management\n in Amazon S3 User Guide.
\nA successful action returns either the 200 OK or 202 Accepted\n status code.
If the object is not previously restored, then Amazon S3 returns 202\n Accepted in the response.
If the object is previously restored, Amazon S3 returns 200 OK in the\n response.
Special errors:
\n\n Code: RestoreAlreadyInProgress\n
\n\n Cause: Object restore is already in progress. (This error does not\n apply to SELECT type requests.)\n
\n\n HTTP Status Code: 409 Conflict\n
\n\n SOAP Fault Code Prefix: Client\n
\n\n Code: GlacierExpeditedRetrievalNotAvailable\n
\n\n Cause: expedited retrievals are currently not available. Try again\n later. (Returned if there is insufficient capacity to process the Expedited\n request. This error applies only to Expedited retrievals and not to\n S3 Standard or Bulk retrievals.)\n
\n\n HTTP Status Code: 503\n
\n\n SOAP Fault Code Prefix: N/A\n
\nThe following operations are related to RestoreObject:
The bucket name containing the object to restore.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The bucket name containing the object to restore.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key\n to use for encrypting inventory reports.
", + "smithy.api#documentation": "Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption\n customer managed key to use for encrypting inventory reports.
", "smithy.api#required": {} } } @@ -32808,7 +32808,7 @@ "target": "com.amazonaws.s3#SelectObjectContentOutput" }, "traits": { - "smithy.api#documentation": "This action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.
\nThis action is not supported by Amazon S3 on Outposts.
\nFor more information about Amazon S3 Select,\n see Selecting Content from\n Objects and SELECT\n Command in the Amazon S3 User Guide.
\nFor more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select\n and S3 Glacier Select in the Amazon S3 User Guide.
\n \n\n Permissions\n
\nYou must have s3:GetObject permission for this operation. Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy\n in the Amazon S3 User Guide.
\n Object Data Formats\n
\nYou can use Amazon S3 Select to query objects that have the following format\n properties:
\n\n CSV, JSON, and Parquet - Objects must be in CSV, JSON, or\n Parquet format.
\n\n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.
\n\n GZIP or BZIP2 - CSV and JSON files can be compressed using\n GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select\n supports for CSV and JSON files. Amazon S3 Select supports columnar compression for\n Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression\n for Parquet objects.
\n\n Server-side encryption - Amazon S3 Select supports querying\n objects that are protected with server-side encryption.
\nFor objects that are encrypted with customer-provided encryption keys (SSE-C), you\n 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\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\nFor objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and\n Amazon Web Services KMS keys (SSE-KMS),\n server-side encryption is handled transparently, so you don't need to specify\n anything. For more information about server-side encryption, including SSE-S3 and\n SSE-KMS, see Protecting Data Using\n Server-Side Encryption in the Amazon S3 User Guide.
\n\n Working with the Response Body\n
\nGiven the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding header with chunked as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response.
\n GetObject Support\n
\nThe SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.
\n Range: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request parameters),\n you cannot specify the range of bytes of an object to return.
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify\n the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For\n more information, about storage classes see Storage Classes\n in the Amazon S3 User Guide.
\n Special Errors\n
\nFor a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n
\n\n Related Resources\n
\n\n GetObject\n
\nThis action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.
\nThis action is not supported by Amazon S3 on Outposts.
\nFor more information about Amazon S3 Select, see Selecting Content from\n Objects and SELECT\n Command in the Amazon S3 User Guide.
\n \nYou must have s3:GetObject permission for this operation. Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying\n Permissions in a Policy in the Amazon S3 User Guide.
You can use Amazon S3 Select to query objects that have the following format\n properties:
\n\n CSV, JSON, and Parquet - Objects must be in CSV, JSON, or\n Parquet format.
\n\n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.
\n\n GZIP or BZIP2 - CSV and JSON files can be compressed using\n GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select\n supports for CSV and JSON files. Amazon S3 Select supports columnar compression for\n Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression\n for Parquet objects.
\n\n Server-side encryption - Amazon S3 Select supports querying\n objects that are protected with server-side encryption.
\nFor objects that are encrypted with customer-provided encryption keys (SSE-C), you\n must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side\n Encryption (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\nFor objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys\n (SSE-KMS), server-side encryption is handled transparently, so you don't need to\n specify anything. For more information about server-side encryption, including SSE-S3\n and SSE-KMS, see Protecting Data Using\n Server-Side Encryption in the Amazon S3 User Guide.
\nGiven the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding header with chunked as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response.
The SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.
\n Range: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request parameters),\n you cannot specify the range of bytes of an object to return.
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify\n the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For\n more information, about storage classes see Storage\n Classes in the Amazon S3 User Guide.
For a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n
\nThe following operations are related to SelectObjectContent:
\n GetObject\n
\nAmazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default\n encryption. This parameter is allowed if and only if SSEAlgorithm is set to\n aws:kms.
You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if\n you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS\n key ARN. For more information, see Using encryption for cross-account operations.
\n\n For example:\n
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see\n Using symmetric and\n asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.
\nAmazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default\n encryption. This parameter is allowed if and only if SSEAlgorithm is set to\n aws:kms.
You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. If you use\n a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow\n log.
\nIf you are using encryption with cross-account or Amazon Web Services service operations you must use\n a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service\n Developer Guide.
\nDescribes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates \n an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted with\n SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see PUT Bucket encryption in\n the Amazon S3 API Reference.
" + "smithy.api#documentation": "Describes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates\n an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted\n with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more\n information, see PUT Bucket encryption in\n the Amazon S3 API Reference.
" } }, "com.amazonaws.s3#ServerSideEncryptionConfiguration": { @@ -33070,7 +33070,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled.
For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
" + "smithy.api#documentation": "Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS\n (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the\n BucketKeyEnabled element to true causes Amazon S3 to use an S3\n Bucket Key. By default, S3 Bucket Key is not enabled.
For more information, see Amazon S3 Bucket Keys in the\n Amazon S3 User Guide.
" } } }, @@ -33108,7 +33108,7 @@ "SseKmsEncryptedObjects": { "target": "com.amazonaws.s3#SseKmsEncryptedObjects", "traits": { - "smithy.api#documentation": " A container for filter information for the selection of Amazon S3 objects encrypted with Amazon Web Services\n KMS. If you include SourceSelectionCriteria in the replication configuration,\n this element is required.
A container for filter information for the selection of Amazon S3 objects encrypted with\n Amazon Web Services KMS. If you include SourceSelectionCriteria in the replication\n configuration, this element is required.
A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer managed key stored in Amazon Web Services Key Management\n Service (SSE-KMS).
" + "smithy.api#documentation": "A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service\n (SSE-KMS).
" } }, "com.amazonaws.s3#SseKmsEncryptedObjects": { @@ -33424,7 +33424,7 @@ } }, "traits": { - "smithy.api#documentation": "Container for granting information.
\nBuckets that use the bucket owner enforced setting for Object\n Ownership don't support target grants. For more information, see Permissions server access log delivery in the\n Amazon S3 User Guide.
" + "smithy.api#documentation": "Container for granting information.
\nBuckets that use the bucket owner enforced setting for Object Ownership don't support\n target grants. For more information, see Permissions server access log delivery in the\n Amazon S3 User Guide.
" } }, "com.amazonaws.s3#TargetGrants": { @@ -33476,7 +33476,7 @@ "AccessTier": { "target": "com.amazonaws.s3#IntelligentTieringAccessTier", "traits": { - "smithy.api#documentation": "S3 Intelligent-Tiering access tier. See Storage class for\n automatically optimizing frequently and infrequently accessed objects for a list\n of access tiers in the S3 Intelligent-Tiering storage class.
", + "smithy.api#documentation": "S3 Intelligent-Tiering access tier. See Storage class\n for automatically optimizing frequently and infrequently accessed objects for a\n list of access tiers in the S3 Intelligent-Tiering storage class.
", "smithy.api#required": {} } } @@ -33649,7 +33649,7 @@ "aws.protocols#httpChecksum": { "requestAlgorithmMember": "ChecksumAlgorithm" }, - "smithy.api#documentation": "Uploads a part in a multipart upload.
\nIn this operation, you provide part data in your request. However, you have an option\n to specify your existing Amazon S3 object as a data source for the part you are uploading. To\n upload a part from an existing object, you use the UploadPartCopy operation.\n
\nYou must initiate a multipart upload (see CreateMultipartUpload)\n before you can upload any part. In response to your initiate request, Amazon S3 returns an\n upload ID, a unique identifier, that you must include in your upload part request.
\nPart numbers can be any number from 1 to 10,000, inclusive. A part number uniquely\n identifies a part and also defines its position within the object being created. If you\n upload a new part using the same part number that was used with a previous part, the\n previously uploaded part is overwritten.
\nFor information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.
\nTo ensure that data is not corrupted when traversing the network, specify the\n Content-MD5 header in the upload part request. Amazon S3 checks the part data\n 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\n x-amz-content-sha256 header as a checksum instead of\n Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version\n 4).
\n Note: After you initiate multipart upload and upload\n one or more parts, you must either complete or abort multipart upload in order to stop\n getting charged for storage of the uploaded parts. Only after you either complete or abort\n multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts\n storage.
\nFor more information on multipart uploads, go to Multipart Upload Overview in the\n Amazon S3 User Guide .
\nFor information on the permissions required to use the multipart upload API, go to\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.
\nYou can optionally request server-side encryption where Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it for you when you access it. You have\n the option of providing your own encryption key, or you can use the Amazon Web Services managed encryption\n keys. If you choose to provide your own encryption key, the request headers you provide in\n the request must match the headers you used in the request to initiate the upload by using\n CreateMultipartUpload. For more information, go to Using Server-Side Encryption in\n the Amazon S3 User Guide.
\nServer-side encryption is supported by the S3 Multipart Upload actions. Unless you are\n using a customer-provided encryption key, you don't need to specify the encryption\n parameters in each UploadPart request. Instead, you only need to specify the server-side\n encryption parameters in the initial Initiate Multipart request. For more information, see\n CreateMultipartUpload.
\nIf you requested server-side encryption using a customer-provided encryption key in your\n initiate multipart upload request, you must provide identical encryption information in\n each part upload using the following headers.
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\n\n Special Errors\n
\n\n Code: NoSuchUpload\n
\n\n Cause: The specified multipart upload does not exist. The upload\n ID might be invalid, or the multipart upload might have been aborted or\n completed.\n
\n\n HTTP Status Code: 404 Not Found \n
\n\n SOAP Fault Code Prefix: Client\n
\n\n Related Resources\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nUploads a part in a multipart upload.
\nIn this operation, you provide part data in your request. However, you have an option\n to specify your existing Amazon S3 object as a data source for the part you are uploading. To\n upload a part from an existing object, you use the UploadPartCopy operation.\n
\nYou must initiate a multipart upload (see CreateMultipartUpload)\n before you can upload any part. In response to your initiate request, Amazon S3 returns an\n upload ID, a unique identifier, that you must include in your upload part request.
\nPart numbers can be any number from 1 to 10,000, inclusive. A part number uniquely\n identifies a part and also defines its position within the object being created. If you\n upload a new part using the same part number that was used with a previous part, the\n previously uploaded part is overwritten.
\nFor information about maximum and minimum part sizes and other multipart upload\n specifications, see Multipart upload limits in the Amazon S3 User Guide.
\nTo ensure that data is not corrupted when traversing the network, specify the\n Content-MD5 header in the upload part request. Amazon S3 checks the part data\n 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\n x-amz-content-sha256 header as a checksum instead of\n Content-MD5. For more information see Authenticating\n Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).
\n Note: After you initiate multipart upload and upload\n one or more parts, you must either complete or abort multipart upload in order to stop\n getting charged for storage of the uploaded parts. Only after you either complete or abort\n multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts\n storage.
\nFor more information on multipart uploads, go to Multipart Upload Overview in the\n Amazon S3 User Guide .
\nFor information on the permissions required to use the multipart upload API, go to\n Multipart\n Upload and Permissions in the Amazon S3 User Guide.
\nServer-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it when you access it. You have three\n mutually exclusive options to protect data using server-side encryption in Amazon S3, depending\n on how you choose to manage the encryption keys. Specifically, the encryption key options\n are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys\n (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by\n default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption\n with other key options. The option you use depends on whether you want to use KMS keys\n (SSE-KMS) or provide your own encryption key (SSE-C). If you choose to provide your own\n encryption key, the request headers you provide in the request must match the headers you\n used in the request to initiate the upload by using CreateMultipartUpload.\n For more information, go to Using Server-Side\n Encryption in the Amazon S3 User Guide.
\nServer-side encryption is supported by the S3 Multipart Upload actions. Unless you are\n using a customer-provided encryption key (SSE-C), you don't need to specify the encryption\n parameters in each UploadPart request. Instead, you only need to specify the server-side\n encryption parameters in the initial Initiate Multipart request. For more information, see\n CreateMultipartUpload.
\nIf you requested server-side encryption using a customer-provided encryption key (SSE-C)\n in your initiate multipart upload request, you must provide identical encryption\n information in each part upload using the following headers.
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\n\n UploadPart has the following special errors:
\n Code: NoSuchUpload\n
\n\n Cause: The specified multipart upload does not exist. The upload\n ID might be invalid, or the multipart upload might have been aborted or\n completed.\n
\n\n HTTP Status Code: 404 Not Found \n
\n\n SOAP Fault Code Prefix: Client\n
\nThe following operations are related to UploadPart:
\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nUploads a part by copying data from an existing object as data source. You specify the\n data source by adding the request header x-amz-copy-source in your request and\n a byte range by adding the request header x-amz-copy-source-range in your\n request.
For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.
\nInstead of using an existing object as part data, you might use the UploadPart\n action and provide data in your request.
\nYou must initiate a multipart upload before you can upload any part. In response to your\n initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in\n your upload part request.
\nFor more information about using the UploadPartCopy operation, see the\n following:
For conceptual information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon S3 User Guide.
\nFor information about permissions required to use the multipart upload API, see\n Multipart Upload and\n Permissions in the Amazon S3 User Guide.
\nFor information about copying objects using a single atomic action vs. a multipart\n upload, see Operations on Objects in\n the Amazon S3 User Guide.
\nFor information about using server-side encryption with customer-provided\n encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.
Note the following additional considerations about the request headers\n x-amz-copy-source-if-match, x-amz-copy-source-if-none-match,\n x-amz-copy-source-if-unmodified-since, and\n x-amz-copy-source-if-modified-since:
\n
\n Consideration 1 - If both of the\n x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the\n request as follows:
\n x-amz-copy-source-if-match condition evaluates to true,\n and;
\n x-amz-copy-source-if-unmodified-since condition evaluates to\n false;
Amazon S3 returns 200 OK and copies the data.\n
\n Consideration 2 - If both of the\n x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the\n request as follows:
\n x-amz-copy-source-if-none-match condition evaluates to\n false, and;
\n x-amz-copy-source-if-modified-since condition evaluates to\n true;
Amazon S3 returns 412 Precondition Failed response code.\n
\n Versioning\n
\nIf your bucket has versioning enabled, you could have multiple versions of the same\n object. By default, x-amz-copy-source identifies the current version of the\n object to copy. If the current version is a delete marker and you don't specify a versionId\n in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does\n not exist. If you specify versionId in the x-amz-copy-source and the versionId\n is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify\n 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\n versionId subresource as shown in the following example:
\n x-amz-copy-source: /bucket/object?versionId=version id\n
\n Special Errors\n
\n\n Code: NoSuchUpload\n
\n\n Cause: The specified multipart upload does not exist. The upload\n ID might be invalid, or the multipart upload might have been aborted or\n completed.\n
\n\n HTTP Status Code: 404 Not Found\n
\n\n Code: InvalidRequest\n
\n\n Cause: The specified copy source is not supported as a byte-range\n copy source.\n
\n\n HTTP Status Code: 400 Bad Request\n
\n\n Related Resources\n
\n\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nUploads a part by copying data from an existing object as data source. You specify the\n data source by adding the request header x-amz-copy-source in your request and\n a byte range by adding the request header x-amz-copy-source-range in your\n request.
For information about maximum and minimum part sizes and other multipart upload\n specifications, see Multipart upload limits in the Amazon S3 User Guide.
\nInstead of using an existing object as part data, you might use the UploadPart\n action and provide data in your request.
\nYou must initiate a multipart upload before you can upload any part. In response to your\n initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in\n your upload part request.
\nFor more information about using the UploadPartCopy operation, see the\n following:
For conceptual information about multipart uploads, see Uploading\n Objects Using Multipart Upload in the\n Amazon S3 User Guide.
\nFor information about permissions required to use the multipart upload API, see\n Multipart Upload and Permissions in the\n Amazon S3 User Guide.
\nFor information about copying objects using a single atomic action vs. a multipart\n upload, see Operations on Objects in\n the Amazon S3 User Guide.
\nFor information about using server-side encryption with customer-provided\n encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.
Note the following additional considerations about the request headers\n x-amz-copy-source-if-match, x-amz-copy-source-if-none-match,\n x-amz-copy-source-if-unmodified-since, and\n x-amz-copy-source-if-modified-since:
\n
\n Consideration 1 - If both of the\n x-amz-copy-source-if-match and\n x-amz-copy-source-if-unmodified-since headers are present in the\n request as follows:
\n x-amz-copy-source-if-match condition evaluates to true,\n and;
\n x-amz-copy-source-if-unmodified-since condition evaluates to\n false;
Amazon S3 returns 200 OK and copies the data.\n
\n Consideration 2 - If both of the\n x-amz-copy-source-if-none-match and\n x-amz-copy-source-if-modified-since headers are present in the\n request as follows:
\n x-amz-copy-source-if-none-match condition evaluates to\n false, and;
\n x-amz-copy-source-if-modified-since condition evaluates to\n true;
Amazon S3 returns 412 Precondition Failed response code.\n
If your bucket has versioning enabled, you could have multiple versions of the same\n object. By default, x-amz-copy-source identifies the current version of the\n object to copy. If the current version is a delete marker and you don't specify a versionId\n in the x-amz-copy-source, Amazon S3 returns a 404 error, because the object does\n not exist. If you specify versionId in the x-amz-copy-source and the versionId\n is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify\n 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\n versionId subresource as shown in the following example:
\n x-amz-copy-source: /bucket/object?versionId=version id\n
\n Code: NoSuchUpload\n
\n\n Cause: The specified multipart upload does not exist. The upload\n ID might be invalid, or the multipart upload might have been aborted or\n completed.\n
\n\n HTTP Status Code: 404 Not Found\n
\n\n Code: InvalidRequest\n
\n\n Cause: The specified copy source is not supported as a byte-range\n copy source.\n
\n\n HTTP Status Code: 400 Bad Request\n
\nThe following operations are related to UploadPartCopy:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThe server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed key that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -33723,7 +33723,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Amazon Web Services KMS (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -33744,7 +33744,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The bucket name.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The bucket name.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n customer managed key was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -33957,7 +33957,7 @@ "target": "com.amazonaws.s3#BucketKeyEnabled", "traits": { "smithy.api#default": false, - "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
", + "smithy.api#documentation": "Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption\n with Amazon Web Services KMS (SSE-KMS).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-bucket-key-enabled" } }, @@ -33986,7 +33986,7 @@ "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The name of the bucket to which the multipart upload was initiated.
\nWhen 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.
\nWhen 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with 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 Amazon S3 on Outposts in the Amazon S3 User Guide.
The name of the bucket to which the multipart upload was initiated.
\nWhen 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.
\nWhen you use 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 \n AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the Amazon S3 User Guide.
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any\n additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.
This checksum algorithm must be the same for all parts and it match the checksum\n value supplied in the CreateMultipartUpload request.
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any\n additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or\n x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more\n information, see Checking object integrity in\n the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided\n ChecksumAlgorithm parameter.
This checksum algorithm must be the same for all parts and it match the checksum value\n supplied in the CreateMultipartUpload request.
Passes transformed\n objects to a GetObject operation when using Object Lambda access points. For information about\n Object Lambda access points, see Transforming objects with\n Object Lambda access points in the Amazon S3 User Guide.
This operation supports metadata that can be returned by GetObject, in addition to\n RequestRoute, RequestToken, StatusCode,\n ErrorCode, and ErrorMessage. The GetObject\n response metadata is supported so that the WriteGetObjectResponse caller,\n typically an Lambda function, can provide the same metadata when it internally invokes\n GetObject. When WriteGetObjectResponse is called by a\n customer-owned Lambda function, the metadata returned to the end user\n 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\n prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue.\n 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\n personally identifiable information (PII) and decompress S3 objects. These Lambda functions\n 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\n Object Lambda access point.
\nExample 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.
\nExample 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.
\nExample 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.
\nFor information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.
", + "smithy.api#documentation": "Passes transformed objects to a GetObject operation when using Object Lambda access points. For\n information about Object Lambda access points, see Transforming objects with\n Object Lambda access points in the Amazon S3 User Guide.
This operation supports metadata that can be returned by GetObject, in addition to\n RequestRoute, RequestToken, StatusCode,\n ErrorCode, and ErrorMessage. The GetObject\n response metadata is supported so that the WriteGetObjectResponse caller,\n typically an Lambda function, can provide the same metadata when it internally invokes\n GetObject. When WriteGetObjectResponse is called by a\n customer-owned Lambda function, the metadata returned to the end user\n 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\n should be prefaced with x-amz-meta. For example,\n x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this\n is to forward GetObject metadata.
Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to\n detect and redact personally identifiable information (PII) and decompress S3 objects.\n These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and\n can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.
\nExample 1: PII Access Control - This Lambda function uses Amazon Comprehend, a\n natural language processing (NLP) service using machine learning to find insights and\n relationships in text. It automatically detects personally identifiable information (PII)\n such as names, addresses, dates, credit card numbers, and social security numbers from\n documents in your Amazon S3 bucket.
\nExample 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural\n language processing (NLP) service using machine learning to find insights and relationships\n in text. It automatically redacts personally identifiable information (PII) such as names,\n addresses, dates, credit card numbers, and social security numbers from documents in your\n Amazon S3 bucket.
\nExample 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is\n equipped to decompress objects stored in S3 in one of six compressed file formats including\n bzip2, gzip, snappy, zlib, zstandard and ZIP.
\nFor information on how to view and use these functions, see Using Amazon Web Services built Lambda\n functions in the Amazon S3 User Guide.
", "smithy.api#endpoint": { "hostPrefix": "{RequestRoute}." }, @@ -34246,7 +34246,7 @@ "target": "com.amazonaws.s3#GetObjectResponseStatusCode", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The integer status code for an HTTP response of a corresponding GetObject\n request.
\n Status Codes\n
\n\n 200 - OK\n
\n 206 - Partial Content\n
\n 304 - Not Modified\n
\n 400 - Bad Request\n
\n 401 - Unauthorized\n
\n 403 - Forbidden\n
\n 404 - Not Found\n
\n 405 - Method Not Allowed\n
\n 409 - Conflict\n
\n 411 - Length Required\n
\n 412 - Precondition Failed\n
\n 416 - Range Not Satisfiable\n
\n 500 - Internal Server Error\n
\n 503 - Service Unavailable\n
The integer status code for an HTTP response of a corresponding GetObject\n request. The following is a list of status codes.
\n 200 - OK\n
\n 206 - Partial Content\n
\n 304 - Not Modified\n
\n 400 - Bad Request\n
\n 401 - Unauthorized\n
\n 403 - Forbidden\n
\n 404 - Not Found\n
\n 405 - Method Not Allowed\n
\n 409 - Conflict\n
\n 411 - Length Required\n
\n 412 - Precondition Failed\n
\n 416 - Range Not Satisfiable\n
\n 500 - Internal Server Error\n
\n 503 - Service Unavailable\n
Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.
", + "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.
", "smithy.api#httpHeader": "x-amz-fwd-header-Content-Encoding" } }, @@ -34324,28 +34324,28 @@ "ChecksumCRC32": { "target": "com.amazonaws.s3#ChecksumCRC32", "traits": { - "smithy.api#documentation": "This header can be used as a data integrity check to verify that the data received is the\n same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32 checksum\n of the object returned by the Object Lambda function. This may not match the checksum for the\n object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original\n GetObject request required checksum validation. For more information about checksums, see\n Checking\n object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple\n checksum headers, this request will fail.
\n ", + "smithy.api#documentation": "This header can be used as a data integrity check to verify that the data received is\n the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32\n checksum of the object returned by the Object Lambda function. This may not match the\n checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values\n only when the original GetObject request required checksum validation. For\n more information about checksums, see Checking object\n integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.
\n ", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-checksum-crc32" } }, "ChecksumCRC32C": { "target": "com.amazonaws.s3#ChecksumCRC32C", "traits": { - "smithy.api#documentation": "This header can be used as a data integrity check to verify that the data received is the\n same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32C checksum\n of the object returned by the Object Lambda function. This may not match the checksum for the\n object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original\n GetObject request required checksum validation. For more information about checksums, see\n Checking\n object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple\n checksum headers, this request will fail.
", + "smithy.api#documentation": "This header can be used as a data integrity check to verify that the data received is\n the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC32C\n checksum of the object returned by the Object Lambda function. This may not match the\n checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values\n only when the original GetObject request required checksum validation. For\n more information about checksums, see Checking object\n integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.
", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-checksum-crc32c" } }, "ChecksumSHA1": { "target": "com.amazonaws.s3#ChecksumSHA1", "traits": { - "smithy.api#documentation": "This header can be used as a data integrity check to verify that the data received is the\n same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1 digest\n of the object returned by the Object Lambda function. This may not match the checksum for the\n object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original\n GetObject request required checksum validation. For more information about checksums, see\n Checking\n object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple\n checksum headers, this request will fail.
", + "smithy.api#documentation": "This header can be used as a data integrity check to verify that the data received is\n the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1\n digest of the object returned by the Object Lambda function. This may not match the\n checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values\n only when the original GetObject request required checksum validation. For\n more information about checksums, see Checking object\n integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.
", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-checksum-sha1" } }, "ChecksumSHA256": { "target": "com.amazonaws.s3#ChecksumSHA256", "traits": { - "smithy.api#documentation": "This header can be used as a data integrity check to verify that the data received is the\n same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256 digest\n of the object returned by the Object Lambda function. This may not match the checksum for the\n object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original\n GetObject request required checksum validation. For more information about checksums, see\n Checking\n object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple\n checksum headers, this request will fail.
", + "smithy.api#documentation": "This header can be used as a data integrity check to verify that the data received is\n the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256\n digest of the object returned by the Object Lambda function. This may not match the\n checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values\n only when the original GetObject request required checksum validation. For\n more information about checksums, see Checking object\n integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum\n headers, this request will fail.
", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-checksum-sha256" } }, @@ -34374,7 +34374,7 @@ "Expiration": { "target": "com.amazonaws.s3#Expiration", "traits": { - "smithy.api#documentation": "If the object expiration is configured (see PUT Bucket lifecycle), the response\n includes this header. It includes the expiry-date and rule-id\n key-value pairs that provide the object expiration information. The value of the\n rule-id is URL-encoded.
If the object expiration is configured (see PUT Bucket lifecycle), the response includes\n this header. It includes the expiry-date and rule-id key-value\n pairs that provide the object expiration information. The value of the rule-id\n is URL-encoded.
Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more\n information about S3 Object Lock, see Object Lock.
", + "smithy.api#documentation": "Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information\n about S3 Object Lock, see Object Lock.
", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-object-lock-mode" } }, @@ -34432,7 +34432,7 @@ "ReplicationStatus": { "target": "com.amazonaws.s3#ReplicationStatus", "traits": { - "smithy.api#documentation": "Indicates if request involves bucket that is either a source or destination in a Replication rule. For more\n information about S3 Replication, see Replication.
", + "smithy.api#documentation": "Indicates if request involves bucket that is either a source or destination in a\n Replication rule. For more information about S3 Replication, see Replication.
", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-replication-status" } }, @@ -34445,28 +34445,28 @@ "Restore": { "target": "com.amazonaws.s3#Restore", "traits": { - "smithy.api#documentation": "Provides information about object restoration operation and expiration time of the\n restored object copy.
", + "smithy.api#documentation": "Provides information about object restoration operation and expiration time of the\n restored object copy.
", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-restore" } }, "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).
", + "smithy.api#documentation": " The server-side encryption algorithm used when storing requested object in Amazon S3 (for\n example, AES256, aws:kms).
Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
", + "smithy.api#documentation": "Encryption algorithm used if server-side encryption with a customer-provided encryption\n key was specified for object stored in Amazon S3.
", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-server-side-encryption-customer-algorithm" } }, "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "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.
", + "smithy.api#documentation": "If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric\n encryption customer managed key that was used for stored in Amazon S3 object.
", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-server-side-encryption-aws-kms-key-id" } }, @@ -34480,7 +34480,7 @@ "StorageClass": { "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\nFor more information, see Storage\n Classes.
", + "smithy.api#documentation": "Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\nFor more information, see Storage Classes.
", "smithy.api#httpHeader": "x-amz-fwd-header-x-amz-storage-class" } }, diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index 9fcb60afcf4..651e48a29fb 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -44513,6 +44513,42 @@ "traits": { "smithy.api#enumValue": "ml.p4de.24xlarge" } + }, + "ML_TRN1_2XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.2xlarge" + } + }, + "ML_TRN1_32XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.trn1.32xlarge" + } + }, + "ML_INF2_XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.xlarge" + } + }, + "ML_INF2_8XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.8xlarge" + } + }, + "ML_INF2_24XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.24xlarge" + } + }, + "ML_INF2_48XLARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ml.inf2.48xlarge" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/securityhub.json b/codegen/sdk-codegen/aws-models/securityhub.json index 2cf071bb74c..e2247b95fd5 100644 --- a/codegen/sdk-codegen/aws-models/securityhub.json +++ b/codegen/sdk-codegen/aws-models/securityhub.json @@ -15922,7 +15922,7 @@ "GeneratorId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The identifier for the solution-specific component (a discrete unit of logic) that\n generated a finding. In various security-findings providers' solutions, this generator can\n be called a rule, a check, a detector, a plugin, etc.
", + "smithy.api#documentation": "The identifier for the solution-specific component (a discrete unit of logic) that\n generated a finding. In various security findings providers' solutions, this generator can\n be called a rule, a check, a detector, a plugin, etc.
", "smithy.api#required": {} } }, @@ -15942,26 +15942,26 @@ "FirstObservedAt": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "Indicates when the security-findings provider first observed the potential security\n issue that a finding captured.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security findings provider first observed the potential security\n issue that a finding captured.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security-findings provider most recently observed the potential\n security issue that a finding captured.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security findings provider most recently observed the potential\n security issue that a finding captured.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security-findings provider created the potential security issue that\n a finding captured.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security findings provider created the potential security issue that\n a finding captured.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security-findings provider last updated the finding record.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
Indicates when the security findings provider last updated the finding record.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example,\n 2020-03-22T13:22:13.933Z.
A URL that links to a page about the current finding in the security-findings provider's\n solution.
" + "smithy.api#documentation": "A URL that links to a page about the current finding in the security findings provider's\n solution.
" } }, "ProductFields": { "target": "com.amazonaws.securityhub#FieldMap", "traits": { - "smithy.api#documentation": "A data type where security-findings providers can include additional solution-specific\n details that aren't part of the defined AwsSecurityFinding format.
Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 2048 characters.
" + "smithy.api#documentation": "A data type where security findings providers can include additional solution-specific\n details that aren't part of the defined AwsSecurityFinding format.
Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 2048 characters.
" } }, "UserDefinedFields": { @@ -16168,7 +16168,7 @@ "GeneratorId": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "The identifier for the solution-specific component (a discrete unit of logic) that\n generated a finding. In various security-findings providers' solutions, this generator can\n be called a rule, a check, a detector, a plugin, etc.
" + "smithy.api#documentation": "The identifier for the solution-specific component (a discrete unit of logic) that\n generated a finding. In various security findings providers' solutions, this generator can\n be called a rule, a check, a detector, a plugin, etc.
" } }, "Region": { @@ -16186,25 +16186,25 @@ "FirstObservedAt": { "target": "com.amazonaws.securityhub#DateFilterList", "traits": { - "smithy.api#documentation": "An ISO8601-formatted timestamp that indicates when the security-findings provider first\n observed the potential security issue that a finding captured.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An ISO8601-formatted timestamp that indicates when the security findings provider first\n observed the potential security issue that a finding captured.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An ISO8601-formatted timestamp that indicates when the security-findings provider most\n recently observed the potential security issue that a finding captured.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An ISO8601-formatted timestamp that indicates when the security findings provider most\n recently observed the potential security issue that a finding captured.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An ISO8601-formatted timestamp that indicates when the security-findings provider\n captured the potential security issue that a finding captured.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An ISO8601-formatted timestamp that indicates when the security findings provider\n captured the potential security issue that a finding captured.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An ISO8601-formatted timestamp that indicates when the security-findings provider last\n updated the finding record.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
An ISO8601-formatted timestamp that indicates when the security findings provider last\n updated the finding record.
\nA correctly formatted example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated by T. For more information, see RFC 3339 section 5.6, Internet Date/Time Format.
The native severity as defined by the security-findings provider's solution that\n generated the finding.
" + "smithy.api#documentation": "The native severity as defined by the security findings provider's solution that\n generated the finding.
" } }, "SeverityNormalized": { @@ -16264,13 +16264,13 @@ "SourceUrl": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "A URL that links to a page about the current finding in the security-findings provider's\n solution.
" + "smithy.api#documentation": "A URL that links to a page about the current finding in the security findings provider's\n solution.
" } }, "ProductFields": { "target": "com.amazonaws.securityhub#MapFilterList", "traits": { - "smithy.api#documentation": "A data type where security-findings providers can include additional solution-specific\n details that aren't part of the defined AwsSecurityFinding format.
A data type where security findings providers can include additional solution-specific\n details that aren't part of the defined AwsSecurityFinding format.
Identifies a finding to update using BatchUpdateFindings.
Identifies which finding to get the finding history for.
" } }, "com.amazonaws.securityhub#AwsSecurityFindingIdentifierList": { @@ -21022,6 +21022,123 @@ "target": "com.amazonaws.securityhub#FindingAggregator" } }, + "com.amazonaws.securityhub#FindingHistoryRecord": { + "type": "structure", + "members": { + "FindingIdentifier": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifier" + }, + "UpdateTime": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": " An ISO 8601-formatted timestamp that indicates when the security findings provider last\n updated the finding record. A correctly formatted example is\n 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and\n time should be separated by T. For more information, see RFC 3339 section 5.6,\n Internet Date/Time Format.
\n Identifies whether the event marks the creation of a new finding. A value of True means that the finding is \n newly created. A value of False means that the finding isn’t newly created.\n
Identifies the source of the event that changed the finding. For example, an integrated\n Amazon Web Service or third-party partner integration may call \n BatchImportFindings\n , or an Security Hub customer\n may call \n BatchUpdateFindings\n .
\n An array of objects that provides details about the finding change event, including the Amazon Web Services Security \n Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after \n the change.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "\n A token for pagination purposes. Provide this token in the subsequent request to \n GetFindingsHistory\n to get \n up to an additional 100 results of history for the same finding that you specified in your initial request.\n
\n A list of events that changed the specified finding during the specified time period. Each record represents a single \n finding change event.\n
" + } + }, + "com.amazonaws.securityhub#FindingHistoryRecordList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FindingHistoryRecord" + } + }, + "com.amazonaws.securityhub#FindingHistoryUpdate": { + "type": "structure", + "members": { + "UpdatedField": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The ASFF field that changed during the finding change event.\n
" + } + }, + "OldValue": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The value of the ASFF field before the finding change event.\n
" + } + }, + "NewValue": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "\n The value of the ASFF field after the finding change event. To preserve storage and readability, Security Hub omits this value \n if \n FindingHistoryRecord\n exceeds database limits.\n
An array of objects that provides details about a change to a finding, including the\n Amazon Web Services Security Finding Format (ASFF) field that changed, the value of\n the field before the change, and the value of the field after the change.
" + } + }, + "com.amazonaws.securityhub#FindingHistoryUpdateSource": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.securityhub#FindingHistoryUpdateSourceType", + "traits": { + "smithy.api#documentation": "\n Describes the type of finding change event, such as a call to \n BatchImportFindings\n (by an integrated Amazon Web Service or third party partner integration) or \n BatchUpdateFindings\n (by a Security Hub customer). \n
\n The identity of the source that initiated the finding change event. For example, the Amazon Resource Name (ARN) of a partner that calls BatchImportFindings or of a customer that calls BatchUpdateFindings.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Identifies the source of the finding change event. \n
" + } + }, + "com.amazonaws.securityhub#FindingHistoryUpdateSourceType": { + "type": "enum", + "members": { + "BATCH_UPDATE_FINDINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BATCH_UPDATE_FINDINGS" + } + }, + "BATCH_IMPORT_FINDINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BATCH_IMPORT_FINDINGS" + } + } + } + }, + "com.amazonaws.securityhub#FindingHistoryUpdatesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FindingHistoryUpdate" + } + }, "com.amazonaws.securityhub#FindingProviderFields": { "type": "structure", "members": { @@ -21436,6 +21553,102 @@ "smithy.api#output": {} } }, + "com.amazonaws.securityhub#GetFindingHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.securityhub#GetFindingHistoryRequest" + }, + "output": { + "target": "com.amazonaws.securityhub#GetFindingHistoryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.securityhub#InternalException" + }, + { + "target": "com.amazonaws.securityhub#InvalidAccessException" + }, + { + "target": "com.amazonaws.securityhub#InvalidInputException" + }, + { + "target": "com.amazonaws.securityhub#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "\n Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in \n the Amazon Web Services Security Finding Format (ASFF).\n
", + "smithy.api#http": { + "method": "POST", + "uri": "/findingHistory/get", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Records", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.securityhub#GetFindingHistoryRequest": { + "type": "structure", + "members": { + "FindingIdentifier": { + "target": "com.amazonaws.securityhub#AwsSecurityFindingIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "StartTime": { + "target": "com.amazonaws.securityhub#Timestamp", + "traits": { + "smithy.api#documentation": "\n An ISO 8601-formatted timestamp that indicates the start time of the requested finding history. A correctly formatted \n example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated \n by T. For more information, see RFC 3339 \n section 5.6, Internet Date/Time Format.
If you provide values for both StartTime and EndTime,\n Security Hub returns finding history for the specified time period. If you\n provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at\n which the API is called. If you provide a value for EndTime but not for\n StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you\n provide neither StartTime nor EndTime, Security Hub\n returns finding history from the CreatedAt timestamp of the finding to the time at which\n the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is \n limited to 90 days.
\n An ISO 8601-formatted timestamp that indicates the end time of the requested finding history. A correctly formatted \n example is 2020-05-21T20:16:34.724Z. The value cannot contain spaces, and date and time should be separated \n by T. For more information, see RFC 3339 \n section 5.6, Internet Date/Time Format.
If you provide values for both StartTime and EndTime,\n Security Hub returns finding history for the specified time period. If you\n provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at\n which the API is called. If you provide a value for EndTime but not for\n StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you\n provide neither StartTime nor EndTime, Security Hub\n returns finding history from the CreatedAt timestamp of the finding to the time at which\n the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is \n limited to 90 days.
\n A token for pagination purposes. Provide NULL as the initial value. In subsequent requests, provide the \n token included in the response to get up to an additional 100 results of finding history. If you don’t provide \n NextToken, Security Hub returns up to 100 results of finding history for each request.\n
\n The maximum number of results to be returned. If you don’t provide it, Security Hub returns up to 100 results of finding history.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.securityhub#GetFindingHistoryResponse": { + "type": "structure", + "members": { + "Records": { + "target": "com.amazonaws.securityhub#FindingHistoryRecordList", + "traits": { + "smithy.api#documentation": "\n A list of events that altered the specified finding during the specified time period. \n
" + } + }, + "NextToken": { + "target": "com.amazonaws.securityhub#NextToken", + "traits": { + "smithy.api#documentation": "\n A token for pagination purposes. Provide this token in the subsequent request to GetFindingsHistory to \n get up to an additional 100 results of history for the same finding that you specified in your initial request.\n
Adds a permission to a queue for a specific \n principal.\n This allows sharing access to the queue.
\nWhen you create a queue, you have full control access rights for the queue.\n Only you, the owner of the queue, can grant or deny permissions to the queue.\n For more information about these permissions, see\n Allow \n Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.
\n\n AddPermission generates a policy for you. You can use \n \n SetQueueAttributes\n to\n upload your policy. For more information, see\n Using Custom Policies with the Amazon SQS Access Policy Language in\n the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of 7 actions.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nAdds a permission to a queue for a specific principal. This allows sharing\n access to the queue.
\nWhen you create a queue, you have full control access rights for the queue. Only you,\n the owner of the queue, can grant or deny permissions to the queue. For more information\n about these permissions, see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.
\n\n AddPermission generates a policy for you. You can use\n \n SetQueueAttributes\n to upload your\n policy. For more information, see Using Custom Policies with the Amazon SQS Access Policy Language in\n the Amazon SQS Developer Guide.
An Amazon SQS policy can have a maximum of seven actions per statement.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Amazon SQS AddPermission does not support adding a non-account\n principal.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe unique identification of the permission you're setting (for example, AliceSendMessage). Maximum 80 characters. Allowed characters include alphanumeric characters, hyphens (-), and underscores (_).
The unique identification of the permission you're setting (for example,\n AliceSendMessage). Maximum 80 characters. Allowed characters include\n alphanumeric characters, hyphens (-), and underscores\n (_).
The action the client wants to allow for the specified principal. Valid values: the name of any action or *.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service Resource \n in the Amazon SQS Developer Guide.
\nSpecifying SendMessage, DeleteMessage, or ChangeMessageVisibility for ActionName.n also grants permissions for the corresponding batch versions of those actions: SendMessageBatch,\n DeleteMessageBatch, and ChangeMessageVisibilityBatch.
The action the client wants to allow for the specified principal. Valid values: the\n name of any action or *.
For more information about these actions, see Overview of Managing Access Permissions to Your Amazon Simple Queue Service\n Resource in the Amazon SQS Developer Guide.
\nSpecifying SendMessage, DeleteMessage, or\n ChangeMessageVisibility for ActionName.n also grants\n permissions for the corresponding batch versions of those actions:\n SendMessageBatch, DeleteMessageBatch, and\n ChangeMessageVisibilityBatch.
Welcome to the Amazon SQS API Reference.
\nAmazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.
\nFor information on the permissions you need to use this API, see\n Identity and\n access management in the Amazon SQS Developer Guide.\n
\nYou can use Amazon Web Services SDKs to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon SQS Developer Guide\n
\n\n Making API Requests\n
\n\n Amazon Web Services General Reference\n
\nWelcome to the Amazon SQS API Reference.
\nAmazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel\n between applications or microservices. Amazon SQS moves data between distributed application\n components and helps you decouple these components.
\nFor information on the permissions you need to use this API, see Identity and access management in the Amazon SQS Developer\n Guide.\n
\nYou can use Amazon Web Services SDKs to access\n Amazon SQS using your favorite programming language. The SDKs perform tasks such as the\n following automatically:
\nCryptographically sign your service requests
\nRetry requests
\nHandle error responses
\n\n Additional information\n
\n\n Amazon SQS Developer Guide\n
\n\n Making API Requests\n
\n\n Amazon Web Services General Reference\n
\nChanges the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
\nFor example, you have a message with a visibility timeout of 5 minutes. After 3\n minutes, you call ChangeMessageVisibility with a timeout of 10 minutes. You\n can continue to call ChangeMessageVisibility to extend the visibility\n timeout to the maximum allowed time. If you try to extend the visibility timeout beyond\n the maximum, your request is rejected.
An Amazon SQS message has three basic states:
\nSent to a queue by a producer.
\nReceived from the queue by a consumer.
\nDeleted from the queue.
\nA message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.\n A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of inflight messages.
\nLimits that apply to inflight messages are unrelated to the unlimited number of stored messages.
\nFor most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit error message.\n To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.\n To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
\n\nIf you attempt to set the VisibilityTimeout to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout \n for the message reverts to the original timeout value (not to the value you set using the ChangeMessageVisibility action) the next time the message is received.
Changes the visibility timeout of a specified message in a queue to a new value. The\n default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The\n maximum is 12 hours. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
\nFor example, if the default timeout for a queue is 60 seconds, 15 seconds have elapsed\n since you received the message, and you send a ChangeMessageVisibility call with\n VisibilityTimeout set to 10 seconds, the 10 seconds begin to count from\n the time that you make the ChangeMessageVisibility call. Thus, any attempt\n to change the visibility timeout or to delete that message 10 seconds after you\n initially change the visibility timeout (a total of 25 seconds) might result in an\n error.
An Amazon SQS message has three basic states:
\nSent to a queue by a producer.
\nReceived from the queue by a consumer.
\nDeleted from the queue.
\nA message is considered to be stored after it is sent to a queue by a producer, but not yet received from the queue by a consumer (that is, between states 1 and 2). There is no limit to the number of stored messages.\n A message is considered to be in flight after it is received from a queue by a consumer, but not yet deleted from the queue (that is, between states 2 and 3). There is a limit to the number of in flight messages.
\nLimits that apply to in flight messages are unrelated to the unlimited number of stored messages.
\nFor most standard queues (depending on queue traffic and message backlog), there can be a maximum of approximately 120,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). \n If you reach this limit, Amazon SQS returns the OverLimit error message.\n To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.\n To request a limit increase, file a support request.
For FIFO queues, there can be a maximum of 20,000 in flight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.
\nIf you attempt to set the VisibilityTimeout to a value greater than\n the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically\n recalculate and increase the timeout to the maximum remaining time.
Unlike with a queue, when you change the visibility timeout for a specific message\n the timeout value is applied immediately but isn't saved in memory for that message.\n If you don't delete a message after it is received, the visibility timeout for the\n message reverts to the original timeout value (not to the value you set using the\n ChangeMessageVisibility action) the next time the message is\n received.
Changes the visibility timeout of multiple messages. This is a batch version of \n ChangeMessageVisibility. The result of the action on each message is reported individually in the response. \n You can send up to 10 \n ChangeMessageVisibility\n requests with each ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
Changes the visibility timeout of multiple messages. This is a batch version of\n \n ChangeMessageVisibility. The result of the action\n on each message is reported individually in the response. You can send up to 10\n \n ChangeMessageVisibility\n requests with each\n ChangeMessageVisibilityBatch action.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
A list of receipt handles of the messages for which the visibility timeout must be changed.
", + "smithy.api#documentation": "A list of receipt handles of the messages for which the visibility timeout must be\n changed.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "ChangeMessageVisibilityBatchRequestEntry" @@ -1372,7 +1424,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.sqs#ChangeMessageVisibilityBatchRequestEntry": { @@ -1381,7 +1434,7 @@ "Id": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "An identifier for this particular receipt handle used to communicate the result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nAn identifier for this particular receipt handle used to communicate the\n result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nThe new value (in seconds) for the message's visibility timeout.
" } } }, "traits": { - "smithy.api#documentation": "Encloses a receipt handle and an entry id for each message in \n ChangeMessageVisibilityBatch.\n
All of the following list parameters must be prefixed with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value starting with 1. For example, a parameter list for this action might look like this:
\n &ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2\n
\n &ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle\n
\n &ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45\n
Encloses a receipt handle and an entry id for each message in \n ChangeMessageVisibilityBatch.\n
A list of \n ChangeMessageVisibilityBatchResultEntry\n items.
A list of \n ChangeMessageVisibilityBatchResultEntry\n \n items.
For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry\n tag if the message succeeds or a \n BatchResultErrorEntry\n tag if the message fails.
For each message in the batch, the response contains a \n ChangeMessageVisibilityBatchResultEntry\n tag if the message\n succeeds or a \n BatchResultErrorEntry\n tag if the message\n fails.
The receipt handle associated with the message whose visibility timeout is changed. This parameter is returned by the \n ReceiveMessage\n action.
The receipt handle associated with the message whose visibility timeout is changed.\n This parameter is returned by the \n ReceiveMessage\n \n action.
The new value for the message's visibility timeout (in seconds). Values range: 0 to 43200. Maximum: 12 hours.
The new value for the message's visibility timeout (in seconds). Values range:\n 0 to 43200. Maximum: 12 hours.
Creates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:
\nIf you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.
\nIf you don't provide a value for an attribute, the queue is created with the default value for the attribute.
\nIf you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
\nTo successfully create a new queue, you must provide a queue name that adheres to the limits related to queues and is unique within the scope of your queues.
\nAfter you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.
\nTo get the queue URL, use the \n GetQueueUrl\n action. \n GetQueueUrl\n requires only the QueueName parameter.\n be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, CreateQueue returns the queue URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an existing queue, CreateQueue returns an error.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nCreates a new standard or FIFO queue. You can pass one or more attributes in\n the request. Keep the following in mind:
\nIf you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue.
You can't change the queue type after you create it and you can't convert\n an existing standard queue into a FIFO queue. You must either create a new\n FIFO queue for your application or delete your existing standard queue and\n recreate it as a FIFO queue. For more information, see Moving From a Standard Queue to a FIFO Queue in the\n Amazon SQS Developer Guide.
\nIf you don't provide a value for an attribute, the queue is created with the\n default value for the attribute.
\nIf you delete a queue, you must wait at least 60 seconds before creating a\n queue with the same name.
\nTo successfully create a new queue, you must provide a queue name that adheres to the\n limits\n related to queues and is unique within the scope of your queues.
\nAfter you create a queue, you must wait at least one second after the queue is\n created to be able to use the queue.
\nTo get the queue URL, use the \n GetQueueUrl\n action.\n \n GetQueueUrl\n requires only the\n QueueName parameter. be aware of existing queue names:
If you provide the name of an existing queue along with the exact names and\n values of all the queue's attributes, CreateQueue returns the queue\n URL for the existing queue.
If the queue name, attribute names, or attribute values don't match an\n existing queue, CreateQueue returns an error.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe name of the new queue. The following limits apply to this name:
\nA queue name can have up to 80 characters.
\nValid values: alphanumeric characters, hyphens (-), and underscores (_).
A FIFO queue name must end with the .fifo suffix.
Queue URLs and names are case-sensitive.
", + "smithy.api#documentation": "The name of the new queue. The following limits apply to this name:
\nA queue name can have up to 80 characters.
\nValid values: alphanumeric characters, hyphens (-), and\n underscores (_).
A FIFO queue name must end with the .fifo suffix.
Queue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.sqs#TagMap", + "Attributes": { + "target": "com.amazonaws.sqs#QueueAttributeMap", "traits": { - "smithy.api#documentation": "Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\n \nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nTo be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nA map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the CreateQueue action uses:
\n DelaySeconds – The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 seconds (15 minutes). Default: 0.
\n MaximumMessageSize – The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\n MessageRetentionPeriod – The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1\n minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the IAM User Guide.
\n ReceiveMessageWaitTimeSeconds – The length of time, in\n seconds, for which a \n ReceiveMessage\n action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.
\n VisibilityTimeout – The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll – No source queues can specify this queue as the dead-letter\n queue.
\n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the Amazon Web Services managed CMK for Amazon SQS is\n always alias/aws/sqs, the alias of a custom CMK can, for example,\n be alias/MyAlias\n . For more examples, see\n KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds – The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?\n
\n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out)\n queues:
\n\n FifoQueue – Designates a queue as FIFO. Valid values are\n true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. You\n can provide this attribute only during queue creation. You can't change it for\n an existing queue. When you set this attribute, you must also provide the\n MessageGroupId for your messages explicitly.
For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
\n\n ContentBasedDeduplication – Enables content-based\n deduplication. Valid values are true and false. For\n more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId.
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId and you enable\n ContentBasedDeduplication for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and\n the queue doesn't have ContentBasedDeduplication\n set, the action fails with an error.
If the queue has ContentBasedDeduplication set,\n your MessageDeduplicationId overrides the generated\n one.
When ContentBasedDeduplication is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication\n enabled and then another message with a\n MessageDeduplicationId that is the same as the one\n generated for the first MessageDeduplicationId, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Tag" + "smithy.api#xmlName": "Attribute" } }, - "Attributes": { - "target": "com.amazonaws.sqs#QueueAttributeMap", + "tags": { + "target": "com.amazonaws.sqs#TagMap", "traits": { - "smithy.api#documentation": "A map of attributes with their corresponding values.
\nThe following lists the names, descriptions, and values of the special request parameters that the CreateQueue action uses:
\n DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 seconds (15 minutes). Default: 0.\n
\n MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).\n
\n MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer from 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600 (4 days).\n
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies in the Amazon IAM User Guide.\n
\n ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a \n ReceiveMessage\n action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.\n
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
\n\n VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout, see \n Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n While the alias of the Amazon Web Services managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias\n .\n For more examples, see KeyId in the Key Management Service API Reference.\n
\n KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt \n or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security \n but results in more calls to KMS which might incur charges after Free Tier. For more information, see \n How Does the Data Key Reuse Period Work?.\n
\n SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out) queues:
\n\n FifoQueue – Designates a queue as FIFO. Valid values are true and false. If you don't specify the FifoQueue attribute, Amazon SQS creates a standard queue. \n You can provide this attribute only during queue creation. You can't change it for an existing queue. \n When you set this attribute, you must also provide the MessageGroupId for your messages explicitly.
For more information, see \n FIFO queue logic \n in the Amazon SQS Developer Guide.
\n\n ContentBasedDeduplication – Enables content-based deduplication. Valid values are true and false. For more information, see Exactly-once processing in the \n Amazon SQS Developer Guide. Note the following:\n
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nTo be able to tag a queue on creation, you must have the\n sqs:CreateQueue and sqs:TagQueue permissions.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nDeletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle of the message (not the\n MessageId which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.
The ReceiptHandle is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle is different each time you receive a message.\n When you use the DeleteMessage action, you must provide the most\n recently received ReceiptHandle for the message (otherwise, the request\n succeeds, but the message might not be deleted).
For standard queues, it is possible to receive a message even after you\n delete it. This might happen on rare occasions if one of the servers which stores a\n copy of the message is unavailable when you send the request to delete the message.\n The copy remains on the server and might be returned to you during a subsequent\n receive request. You should ensure that your application is idempotent, so that\n receiving a message more than once does not cause issues.
\nDeletes the specified message from the specified queue. To select the message to\n delete, use the ReceiptHandle of the message (not the\n MessageId which you receive when you send the message). Amazon SQS can\n delete a message from a queue even if a visibility timeout setting causes the message to\n be locked by another consumer. Amazon SQS automatically deletes messages left in a queue\n longer than the retention period configured for the queue.
The ReceiptHandle is associated with a specific\n instance of receiving a message. If you receive a message more than\n once, the ReceiptHandle is different each time you receive a message.\n When you use the DeleteMessage action, you must provide the most\n recently received ReceiptHandle for the message (otherwise, the request\n succeeds, but the message will not be deleted).
For standard queues, it is possible to receive a message even after you\n delete it. This might happen on rare occasions if one of the servers which stores a\n copy of the message is unavailable when you send the request to delete the message.\n The copy remains on the server and might be returned to you during a subsequent\n receive request. You should ensure that your application is idempotent, so that\n receiving a message more than once does not cause issues.
\nDeletes up to ten messages from the specified queue. This is a batch version of \n DeleteMessage. The result of the action on each message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
Deletes up to ten messages from the specified queue. This is a batch version of\n \n DeleteMessage. The result of the action on each\n message is reported individually in the response.
Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
An identifier for this particular receipt handle. This is used to communicate the result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nAn identifier for this particular receipt handle. This is used to communicate the\n result.
\nThe Ids of a batch request need to be unique within a request.
This identifier can have up to 80 characters. The following characters are accepted: alphanumeric characters, hyphens(-), and underscores (_).
\nFor each message in the batch, the response contains a \n DeleteMessageBatchResultEntry\n tag if the message is deleted or a \n BatchResultErrorEntry\n tag if the message can't be deleted.
For each message in the batch, the response contains a \n DeleteMessageBatchResultEntry\n tag if the message is deleted\n or a \n BatchResultErrorEntry\n tag if the message can't be\n deleted.
Deletes the queue specified by the QueueUrl, regardless of the queue's contents.
Be careful with the DeleteQueue action: When you delete a queue, any messages in the queue are no longer available.\n
When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a \n \n SendMessage\n request might succeed, but after 60 seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nThe URL of the Amazon SQS queue to delete.
\nQueue URLs and names are case-sensitive.
", - "smithy.api#required": {} - } - } + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the queue specified by the QueueUrl, regardless of the queue's\n contents.
Be careful with the DeleteQueue action: When you delete a queue, any\n messages in the queue are no longer available.
When you delete a queue, the deletion process takes up to 60 seconds. Requests you\n send involving that queue during the 60 seconds might succeed. For example, a\n \n SendMessage\n request might succeed, but after 60\n seconds the queue and the message you sent no longer exist.
When you delete a queue, you must wait at least 60 seconds before creating a queue\n with the same name.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nThe delete operation uses the HTTP GET verb.
The URL of the Amazon SQS queue to delete.
\nQueue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.sqs#EmptyBatchRequest": { "type": "structure", - "members": {}, + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, "traits": { "aws.protocols#awsQueryError": { "code": "AWS.SimpleQueueService.EmptyBatchRequest", @@ -1756,6 +1874,9 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.sqs#ExceptionMessage": { + "type": "string" + }, "com.amazonaws.sqs#GetQueueAttributes": { "type": "operation", "input": { @@ -1767,6 +1888,18 @@ "errors": [ { "target": "com.amazonaws.sqs#InvalidAttributeName" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { @@ -1786,14 +1919,15 @@ "AttributeNames": { "target": "com.amazonaws.sqs#AttributeNameList", "traits": { - "smithy.api#documentation": "A list of attributes for which to retrieve information.
\nThe AttributeName.N parameter is optional, but if you don't specify values for this parameter,\n the request returns empty results.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nThe following attributes are supported:
\nThe ApproximateNumberOfMessagesDelayed, ApproximateNumberOfMessagesNotVisible, \n and ApproximateNumberOfMessagesVisible metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is required for \n the queue metadata to reach eventual consistency.
\n All – Returns all values.
\n ApproximateNumberOfMessages – Returns the approximate number of\n messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed – Returns the approximate number\n of messages in the queue that are delayed and not available for reading\n immediately. This can happen when the queue is configured as a delay queue or\n when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible – Returns the approximate\n number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.
\n CreatedTimestamp – Returns the time when the queue was created in\n seconds (epoch\n time).
\n DelaySeconds – Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp – Returns the time when the queue was last\n changed in seconds (epoch\n time).
\n MaximumMessageSize – Returns the limit of how many bytes a message\n can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod – Returns the length of time, in seconds,\n for which Amazon SQS retains a message.
\n Policy – Returns the policy of the queue.
\n QueueArn – Returns the Amazon resource name (ARN) of the\n queue.
\n ReceiveMessageWaitTimeSeconds – Returns the length of time, in\n seconds, for which the ReceiveMessage action waits for a message to\n arrive.
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n VisibilityTimeout – Returns the visibility timeout for the queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer Guide.\n
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n
\n KmsDataKeyReusePeriodSeconds – Returns the length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.\n For more information, see How Does the Data Key Reuse Period Work?.\n
\n SqsManagedSseEnabled – Returns information about whether the queue is using SSE-SQS encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out) queues:
\n\n FifoQueue – Returns information about whether the queue is FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer Guide.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
\n ContentBasedDeduplication – Returns whether content-based deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer Guide.\n
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "A list of attributes for which to retrieve information.
\nThe AttributeNames parameter is optional, but if you don't specify values\n for this parameter, the request returns empty results.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nThe following attributes are supported:
\nThe ApproximateNumberOfMessagesDelayed,\n ApproximateNumberOfMessagesNotVisible, and\n ApproximateNumberOfMessages metrics may not achieve consistency\n until at least 1 minute after the producers stop sending messages. This period is\n required for the queue metadata to reach eventual consistency.
\n All – Returns all values.
\n ApproximateNumberOfMessages – Returns the approximate\n number of messages available for retrieval from the queue.
\n ApproximateNumberOfMessagesDelayed – Returns the\n approximate number of messages in the queue that are delayed and not available\n for reading immediately. This can happen when the queue is configured as a delay\n queue or when a message has been sent with a delay parameter.
\n ApproximateNumberOfMessagesNotVisible – Returns the\n approximate number of messages that are in flight. Messages are considered to be\n in flight if they have been sent to a client but have\n not yet been deleted or have not yet reached the end of their visibility window.\n
\n CreatedTimestamp – Returns the time when the queue was\n created in seconds (epoch\n time).
\n DelaySeconds – Returns the default delay on the queue in\n seconds.
\n LastModifiedTimestamp – Returns the time when the queue\n was last changed in seconds (epoch time).
\n MaximumMessageSize – Returns the limit of how many bytes a\n message can contain before Amazon SQS rejects it.
\n MessageRetentionPeriod – Returns the length of time, in\n seconds, for which Amazon SQS retains a message. When you change a queue's\n attributes, the change can take up to 60 seconds for most of the attributes to\n propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.
\n Policy – Returns the policy of the queue.
\n QueueArn – Returns the Amazon resource name (ARN) of the\n queue.
\n ReceiveMessageWaitTimeSeconds – Returns the length of\n time, in seconds, for which the ReceiveMessage action waits for a\n message to arrive.
\n VisibilityTimeout – Returns the visibility timeout for the\n queue. For more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll – No source queues can specify this queue as the dead-letter\n queue.
\n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – Returns the ID of an Amazon Web Services managed customer\n master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.
\n KmsDataKeyReusePeriodSeconds – Returns the length of time,\n in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt\n messages before calling KMS again. For more information, see\n How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled – Returns information about whether the\n queue is using SSE-SQS encryption using SQS owned encryption keys. Only one\n server-side encryption option is supported per queue (for example, SSE-KMS or SSE-SQS).
The following attributes apply only to FIFO (first-in-first-out)\n queues:
\n\n FifoQueue – Returns information about whether the queue is\n FIFO. For more information, see FIFO queue logic in the Amazon SQS Developer\n Guide.
To determine whether a queue is FIFO, you can check whether QueueName ends with the .fifo suffix.
\n ContentBasedDeduplication – Returns whether content-based\n deduplication is enabled for the queue. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "AttributeName" } } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.sqs#GetQueueAttributesResult": { @@ -1821,12 +1955,24 @@ "target": "com.amazonaws.sqs#GetQueueUrlResult" }, "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, { "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { - "smithy.api#documentation": "Returns the URL of an existing Amazon SQS queue.
\nTo access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue. \n For more information about shared queue access, see \n AddPermission\n or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS Developer Guide.\n
Returns the URL of an existing Amazon SQS queue.
\nTo access a queue that belongs to another AWS account, use the\n QueueOwnerAWSAccountId parameter to specify the account ID of the\n queue's owner. The queue's owner must grant you permission to access the queue. For more\n information about shared queue access, see \n AddPermission\n \n or see Allow Developers to Write Messages to a Shared Queue in the Amazon SQS\n Developer Guide.
The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values: alphanumeric characters, hyphens (-), and underscores (_).
Queue URLs and names are case-sensitive.
", + "smithy.api#documentation": "The name of the queue whose URL must be fetched. Maximum 80 characters. Valid values:\n alphanumeric characters, hyphens (-), and underscores\n (_).
Queue URLs and names are case-sensitive.
", "smithy.api#required": {} } }, @@ -1847,7 +1993,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.sqs#GetQueueUrlResult": { @@ -1861,32 +2008,63 @@ } }, "traits": { - "smithy.api#documentation": "For more information, see Interpreting Responses in the Amazon SQS Developer Guide.
" + "smithy.api#documentation": "For more information, see Interpreting Responses in the Amazon SQS Developer\n Guide.
" } }, - "com.amazonaws.sqs#Integer": { - "type": "integer", + "com.amazonaws.sqs#InvalidAddress": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, "traits": { - "smithy.api#default": 0 + "aws.protocols#awsQueryError": { + "code": "InvalidAddress", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The accountId is invalid.
The specified attribute doesn't exist.
", "smithy.api#error": "client" } }, + "com.amazonaws.sqs#InvalidAttributeValue": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "smithy.api#documentation": "A queue attribute value is invalid.
", + "smithy.api#error": "client" + } + }, "com.amazonaws.sqs#InvalidBatchEntryId": { "type": "structure", - "members": {}, + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, "traits": { "aws.protocols#awsQueryError": { "code": "AWS.SimpleQueueService.InvalidBatchEntryId", "httpResponseCode": 400 }, - "smithy.api#documentation": "The Id of a batch entry in a batch request doesn't abide by the specification.
The Id of a batch entry in a batch request doesn't abide by the\n specification.
The specified receipt handle isn't valid for the current version.
", "smithy.api#error": "client" } }, "com.amazonaws.sqs#InvalidMessageContents": { "type": "structure", - "members": {}, + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, "traits": { "smithy.api#documentation": "The message contains characters outside the allowed set.
", "smithy.api#error": "client" } }, + "com.amazonaws.sqs#InvalidSecurity": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidSecurity", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "When the request to a queue is not HTTPS and SigV4.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sqs#KmsAccessDenied": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.AccessDeniedException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The caller doesn't have the required KMS access.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsDisabled": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.DisabledException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsInvalidKeyUsage": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.InvalidKeyUsageException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The request was rejected for one of the following reasons:
\nThe KeyUsage value of the KMS key is incompatible with the API\n operation.
\nThe encryption algorithm or signing algorithm specified for the operation is\n incompatible with the type of key material in the KMS key (KeySpec).
\nThe request was rejected because the state of the specified resource is not valid for\n this request.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsNotFound": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.NotFoundException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The request was rejected because the specified entity or resource could not be found.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.sqs#KmsOptInRequired": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.OptInRequired", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "The request was rejected because the specified key policy isn't syntactically or\n semantically correct.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.sqs#KmsThrottled": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "KMS.ThrottlingException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Amazon Web Services KMS throttles requests for the following conditions.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.sqs#ListDeadLetterSourceQueues": { "type": "operation", "input": { @@ -1916,12 +2237,24 @@ "target": "com.amazonaws.sqs#ListDeadLetterSourceQueuesResult" }, "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, { "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { - "smithy.api#documentation": "Returns a list of your queues that have the RedrivePolicy queue attribute configured with a dead-letter queue.
The ListDeadLetterSourceQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n ListDeadLetterSourceQueues to receive the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "Returns a list of your queues that have the RedrivePolicy queue attribute\n configured with a dead-letter queue.
The ListDeadLetterSourceQueues methods supports pagination. Set\n parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults, the\n response includes a maximum of 1,000 results. If you set MaxResults and\n there are additional results to display, the response includes a value for\n NextToken. Use NextToken as a parameter in your next\n request to ListDeadLetterSourceQueues to receive the next page of results.
For more information about using dead-letter queues, see Using Amazon SQS Dead-Letter Queues in the Amazon SQS Developer\n Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1949,12 +2282,13 @@ "MaxResults": { "target": "com.amazonaws.sqs#BoxedInteger", "traits": { - "smithy.api#documentation": "Maximum number of results to include in the response. Value range is 1 to 1000. \n You must set MaxResults to receive a value for NextToken in the response.
Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set MaxResults to receive a value for NextToken in the\n response.
A list of source queue URLs that have the RedrivePolicy queue attribute configured with a dead-letter queue.
A list of source queue URLs that have the RedrivePolicy queue attribute\n configured with a dead-letter queue.
Pagination token to include in the next request. Token value is null if there are no additional\n results to request, or if you did not set MaxResults in the request.
Pagination token to include in the next request. Token value is null if\n there are no additional results to request, or if you did not set\n MaxResults in the request.
List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nList all cost allocation tags added to the specified Amazon SQS queue.\n For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nReturns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional \n QueueNamePrefix parameter, only queues with a name that begins with the specified value are returned.
The listQueues methods supports\n pagination. Set parameter MaxResults in the request to specify the maximum number of\n results to be returned in the response. If you do not set MaxResults,\n the response includes a maximum of 1,000 results. If you set MaxResults and there are additional results to\n display, the response includes a value for NextToken. Use\n NextToken as a parameter in your next request to\n listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nReturns a list of your queues in the current region. The response includes a maximum\n of 1,000 results. If you specify a value for the optional QueueNamePrefix\n parameter, only queues with a name that begins with the specified value are\n returned.
The listQueues methods supports pagination. Set parameter\n MaxResults in the request to specify the maximum number of results to\n be returned in the response. If you do not set MaxResults, the response\n includes a maximum of 1,000 results. If you set MaxResults and there are\n additional results to display, the response includes a value for NextToken.\n Use NextToken as a parameter in your next request to\n listQueues to receive the next page of results.
Cross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nA string to use for filtering the list results. Only those queues whose name begins with the specified string are returned.
\nQueue URLs and names are case-sensitive.
" + "smithy.api#documentation": "A string to use for filtering the list results. Only those queues whose name begins\n with the specified string are returned.
\nQueue URLs and names are case-sensitive.
" } }, "NextToken": { @@ -2053,30 +2421,31 @@ "MaxResults": { "target": "com.amazonaws.sqs#BoxedInteger", "traits": { - "smithy.api#documentation": "Maximum number of results to include in the response. Value range is 1 to 1000. \n You must set MaxResults to receive a value for NextToken in the response.
Maximum number of results to include in the response. Value range is 1 to 1000. You\n must set MaxResults to receive a value for NextToken in the\n response.
Pagination token to include in the next request. Token value is null if there are no additional\n results to request, or if you did not set MaxResults in the request.
A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in the request.
", + "smithy.api#documentation": "A list of queue URLs, up to 1,000 entries, or the value of MaxResults that you sent in\n the request.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "QueueUrl" } + }, + "NextToken": { + "target": "com.amazonaws.sqs#Token", + "traits": { + "smithy.api#documentation": "Pagination token to include in the next request. Token value is null if\n there are no additional results to request, or if you did not set\n MaxResults in the request.
A unique identifier for the message. A MessageIdis considered unique across all Amazon Web Services accounts for an extended period of time.
A unique identifier for the message. A MessageIdis considered unique\n across all Amazon Web Services accounts for an extended period of time.
An identifier associated with the act of receiving the message. A new receipt handle is returned every time you receive a message. When deleting a message, you provide the last received receipt handle to delete the message.
" + "smithy.api#documentation": "An identifier associated with the act of receiving the message. A new receipt handle\n is returned every time you receive a message. When deleting a message, you provide the\n last received receipt handle to delete the message.
" } }, "MD5OfBody": { @@ -2113,7 +2482,7 @@ "Attributes": { "target": "com.amazonaws.sqs#MessageSystemAttributeMap", "traits": { - "smithy.api#documentation": "A map of the attributes requested in \n ReceiveMessage\n to their respective values. \n Supported attributes:
\n ApproximateReceiveCount\n
\n ApproximateFirstReceiveTimestamp\n
\n MessageDeduplicationId\n
\n MessageGroupId\n
\n SenderId\n
\n SentTimestamp\n
\n SequenceNumber\n
\n ApproximateFirstReceiveTimestamp and SentTimestamp are each returned as an integer representing the \n epoch time in milliseconds.
A map of the attributes requested in \n ReceiveMessage\n to\n their respective values. Supported attributes:
\n ApproximateReceiveCount\n
\n ApproximateFirstReceiveTimestamp\n
\n MessageDeduplicationId\n
\n MessageGroupId\n
\n SenderId\n
\n SentTimestamp\n
\n SequenceNumber\n
\n ApproximateFirstReceiveTimestamp and SentTimestamp are each\n returned as an integer representing the epoch time in\n milliseconds.
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
" + "smithy.api#documentation": "Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters.
" } }, "BinaryValue": { "target": "com.amazonaws.sqs#Binary", "traits": { - "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
" + "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images.
" } }, "StringListValues": { @@ -2180,13 +2549,13 @@ "DataType": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "Amazon SQS supports the following logical data types: String,\n Number, and Binary. For the Number data type,\n you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The user-specified message attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not be empty or null. All parts of the message attribute, including Name, Type, and Value, are part of the message size restriction (256 KB or 262,144 bytes).
The user-specified message attribute value. For string data types, the\n Value attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not\n be empty or null. All parts of the message attribute, including Name,\n Type, and Value, are part of the message size restriction\n (256 KiB or 262,144 bytes).
Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable Characters.
" + "smithy.api#documentation": "Strings are Unicode with UTF-8 binary encoding. For a list of code values, see ASCII Printable\n Characters.
" } }, "BinaryValue": { "target": "com.amazonaws.sqs#Binary", "traits": { - "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted data, or images.
" + "smithy.api#documentation": "Binary type attributes can store any binary data, such as compressed data, encrypted\n data, or images.
" } }, "StringListValues": { @@ -2337,189 +2720,259 @@ "DataType": { "target": "com.amazonaws.sqs#String", "traits": { - "smithy.api#documentation": "Amazon SQS supports the following logical data types: String, Number, and Binary. For the Number data type, you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "Amazon SQS supports the following logical data types: String,\n Number, and Binary. For the Number data type,\n you must use StringValue.
You can also append custom labels. For more information, see Amazon SQS Message Attributes in the Amazon SQS Developer\n Guide.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The user-specified message system attribute value. For string data types, the Value attribute has the same restrictions on the content as the message body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not be empty or null.
The user-specified message system attribute value. For string data types, the\n Value attribute has the same restrictions on the content as the message\n body. For more information, see \n SendMessage.\n
\n Name, type, value and the message body must not\n be empty or null.
The specified action violates a limit. For example, ReceiveMessage\n returns this error if the maximum number of inflight messages is reached and\n AddPermission returns this error if the maximum number of permissions\n for the queue is reached.
The specified action violates a limit. For example, ReceiveMessage\n returns this error if the maximum number of in flight messages is reached and\n AddPermission returns this error if the maximum number of permissions\n for the queue is reached.
Deletes the messages in a queue specified by the QueueURL\n parameter.
When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for 60\n seconds regardless of your queue's size.
\nMessages sent to the queue before you call\n PurgeQueue might be received but are deleted within the next\n minute.
Messages sent to the queue after you call PurgeQueue\n might be deleted while the queue is being purged.
Indicates that the specified queue previously received a PurgeQueue\n request within the last 60 seconds (the time it can take to delete the messages in the\n queue).
The URL of the queue from which the PurgeQueue action deletes\n messages.
Queue URLs and names are case-sensitive.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "", + "smithy.api#input": {} + } + }, + "com.amazonaws.sqs#QueueAttributeMap": { + "type": "map", + "key": { + "target": "com.amazonaws.sqs#QueueAttributeName", + "traits": { + "smithy.api#xmlName": "Name" + } + }, + "value": { + "target": "com.amazonaws.sqs#String", + "traits": { + "smithy.api#xmlName": "Value" + } + } + }, + "com.amazonaws.sqs#QueueAttributeName": { + "type": "enum", + "members": { + "All": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "All" + } + }, + "Policy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Policy" + } + }, + "VisibilityTimeout": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VisibilityTimeout" + } + }, + "MaximumMessageSize": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MaximumMessageSize" + } + }, + "MessageRetentionPeriod": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MessageRetentionPeriod" + } + }, + "ApproximateNumberOfMessages": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateNumberOfMessages" + } + }, + "ApproximateNumberOfMessagesNotVisible": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateNumberOfMessagesNotVisible" + } + }, + "CreatedTimestamp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CreatedTimestamp" + } + }, + "LastModifiedTimestamp": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LastModifiedTimestamp" + } + }, + "QueueArn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QueueArn" + } + }, + "ApproximateNumberOfMessagesDelayed": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ApproximateNumberOfMessagesDelayed" + } + }, + "DelaySeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DelaySeconds" + } + }, + "ReceiveMessageWaitTimeSeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ReceiveMessageWaitTimeSeconds" + } + }, + "RedrivePolicy": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RedrivePolicy" + } + }, + "FifoQueue": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FifoQueue" + } + }, + "ContentBasedDeduplication": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ContentBasedDeduplication" + } + }, + "KmsMasterKeyId": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsMasterKeyId" + } + }, + "KmsDataKeyReusePeriodSeconds": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "KmsDataKeyReusePeriodSeconds" + } + }, + "DeduplicationScope": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DeduplicationScope" + } + }, + "FifoThroughputLimit": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FifoThroughputLimit" + } }, - { - "target": "com.amazonaws.sqs#QueueDoesNotExist" - } - ], - "traits": { - "smithy.api#documentation": "Deletes the messages in a queue specified by the QueueURL\n parameter.
When you use the PurgeQueue action, you can't retrieve any messages\n deleted from a queue.
The message deletion process takes up to 60 seconds. We recommend waiting for\n 60 seconds regardless of your queue's size.
\nMessages sent to the queue before you call\n PurgeQueue might be received but are deleted within the next\n minute.
Messages sent to the queue after you call\n PurgeQueue might be deleted while the queue is being purged.
Indicates that the specified queue previously received a PurgeQueue request within the last 60 seconds (the time it can take to delete the messages in the queue).
The URL of the queue from which the PurgeQueue action deletes messages.
Queue URLs and names are case-sensitive.
", - "smithy.api#required": {} + "smithy.api#enumValue": "SqsManagedSseEnabled" } } - }, - "traits": { - "smithy.api#documentation": "" - } - }, - "com.amazonaws.sqs#QueueAttributeMap": { - "type": "map", - "key": { - "target": "com.amazonaws.sqs#QueueAttributeName", - "traits": { - "smithy.api#xmlName": "Name" - } - }, - "value": { - "target": "com.amazonaws.sqs#String", - "traits": { - "smithy.api#xmlName": "Value" - } - } - }, - "com.amazonaws.sqs#QueueAttributeName": { - "type": "string", - "traits": { - "smithy.api#enum": [ - { - "value": "All", - "name": "All" - }, - { - "value": "Policy", - "name": "Policy" - }, - { - "value": "VisibilityTimeout", - "name": "VisibilityTimeout" - }, - { - "value": "MaximumMessageSize", - "name": "MaximumMessageSize" - }, - { - "value": "MessageRetentionPeriod", - "name": "MessageRetentionPeriod" - }, - { - "value": "ApproximateNumberOfMessages", - "name": "ApproximateNumberOfMessages" - }, - { - "value": "ApproximateNumberOfMessagesNotVisible", - "name": "ApproximateNumberOfMessagesNotVisible" - }, - { - "value": "CreatedTimestamp", - "name": "CreatedTimestamp" - }, - { - "value": "LastModifiedTimestamp", - "name": "LastModifiedTimestamp" - }, - { - "value": "QueueArn", - "name": "QueueArn" - }, - { - "value": "ApproximateNumberOfMessagesDelayed", - "name": "ApproximateNumberOfMessagesDelayed" - }, - { - "value": "DelaySeconds", - "name": "DelaySeconds" - }, - { - "value": "ReceiveMessageWaitTimeSeconds", - "name": "ReceiveMessageWaitTimeSeconds" - }, - { - "value": "RedrivePolicy", - "name": "RedrivePolicy" - }, - { - "value": "FifoQueue", - "name": "FifoQueue" - }, - { - "value": "ContentBasedDeduplication", - "name": "ContentBasedDeduplication" - }, - { - "value": "KmsMasterKeyId", - "name": "KmsMasterKeyId" - }, - { - "value": "KmsDataKeyReusePeriodSeconds", - "name": "KmsDataKeyReusePeriodSeconds" - }, - { - "value": "DeduplicationScope", - "name": "DeduplicationScope" - }, - { - "value": "FifoThroughputLimit", - "name": "FifoThroughputLimit" - }, - { - "value": "RedriveAllowPolicy", - "name": "RedriveAllowPolicy" - }, - { - "value": "SqsManagedSseEnabled", - "name": "SqsManagedSseEnabled" - } - ] } }, "com.amazonaws.sqs#QueueDeletedRecently": { "type": "structure", - "members": {}, + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, "traits": { "aws.protocols#awsQueryError": { "code": "AWS.SimpleQueueService.QueueDeletedRecently", @@ -2532,7 +2985,11 @@ }, "com.amazonaws.sqs#QueueDoesNotExist": { "type": "structure", - "members": {}, + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, "traits": { "aws.protocols#awsQueryError": { "code": "AWS.SimpleQueueService.NonExistentQueue", @@ -2545,7 +3002,11 @@ }, "com.amazonaws.sqs#QueueNameExists": { "type": "structure", - "members": {}, + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, "traits": { "aws.protocols#awsQueryError": { "code": "QueueAlreadyExists", @@ -2564,10 +3025,19 @@ }, "com.amazonaws.sqs#ReceiptHandleIsInvalid": { "type": "structure", - "members": {}, + "members": { + "message": { + "target": "com.amazonaws.sqs#ExceptionMessage" + } + }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReceiptHandleIsInvalid", + "httpResponseCode": 404 + }, "smithy.api#documentation": "The specified receipt handle isn't valid.
", - "smithy.api#error": "client" + "smithy.api#error": "client", + "smithy.api#httpError": 404 } }, "com.amazonaws.sqs#ReceiveMessage": { @@ -2579,12 +3049,45 @@ "target": "com.amazonaws.sqs#ReceiveMessageResult" }, "errors": [ + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#KmsAccessDenied" + }, + { + "target": "com.amazonaws.sqs#KmsDisabled" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidKeyUsage" + }, + { + "target": "com.amazonaws.sqs#KmsInvalidState" + }, + { + "target": "com.amazonaws.sqs#KmsNotFound" + }, + { + "target": "com.amazonaws.sqs#KmsOptInRequired" + }, + { + "target": "com.amazonaws.sqs#KmsThrottled" + }, { "target": "com.amazonaws.sqs#OverLimit" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" } ], "traits": { - "smithy.api#documentation": "Retrieves one or more messages (up to 10), from the specified queue. Using the WaitTimeSeconds parameter enables long-poll support. \n For more information, see Amazon SQS Long Polling in the Amazon SQS Developer Guide.\n
Short poll is the default behavior where a weighted random set of machines is sampled on a ReceiveMessage call. Thus, only the messages on the sampled machines are returned. \n If the number of messages in the queue is small (fewer than 1,000), you most likely get fewer messages than you requested per ReceiveMessage call. If the number of messages in the queue is extremely small, \n you might not receive any messages in a particular ReceiveMessage response. If this happens, repeat the request.\n
For each message returned, the response includes the following:
\nThe message body.
\nAn MD5 digest of the message body. For information about MD5, see RFC1321.
\nThe MessageId you received when you sent the message to the queue.
The receipt handle.
\nThe message attributes.
\nAn MD5 digest of the message attributes.
\nThe receipt handle is the identifier you must provide when deleting the message. For more information, see Queue \n and Message Identifiers in the Amazon SQS Developer Guide.
\nYou can provide the VisibilityTimeout parameter in your request. The parameter is applied to the messages that Amazon SQS returns in the response. If you don't include the parameter, the overall visibility timeout for the queue \n is used for the returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer Guide.
A message that isn't deleted or a message whose visibility isn't extended before the visibility timeout expires counts as a failed receive. Depending on the configuration of the queue, the message might be sent to the dead-letter queue.
\nIn the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nRetrieves one or more messages (up to 10), from the specified queue. Using the\n WaitTimeSeconds parameter enables long-poll support. For more\n information, see Amazon SQS\n Long Polling in the Amazon SQS Developer Guide.
Short poll is the default behavior where a weighted random set of machines is sampled\n on a ReceiveMessage call. Thus, only the messages on the sampled machines\n are returned. If the number of messages in the queue is small (fewer than 1,000), you\n most likely get fewer messages than you requested per ReceiveMessage call.\n If the number of messages in the queue is extremely small, you might not receive any\n messages in a particular ReceiveMessage response. If this happens, repeat\n the request.
For each message returned, the response includes the following:
\nThe message body.
\nAn MD5 digest of the message body. For information about MD5, see RFC1321.
\nThe MessageId you received when you sent the message to the\n queue.
The receipt handle.
\nThe message attributes.
\nAn MD5 digest of the message attributes.
\nThe receipt handle is the identifier you must provide when deleting the message. For\n more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.
\nYou can provide the VisibilityTimeout parameter in your request. The\n parameter is applied to the messages that Amazon SQS returns in the response. If you don't\n include the parameter, the overall visibility timeout for the queue is used for the\n returned messages. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
A message that isn't deleted or a message whose visibility isn't extended before the\n visibility timeout expires counts as a failed receive. Depending on the configuration of\n the queue, the message might be sent to the dead-letter queue.
\nIn the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nA list of attributes that need to be returned along with each message. These attributes\n include:
\n\n All – Returns all values.
\n ApproximateFirstReceiveTimestamp – Returns the time the message was first received from the queue (epoch time in milliseconds).
\n ApproximateReceiveCount – Returns the number of times a message has been received across all queues but not deleted.
\n AWSTraceHeader – Returns the X-Ray trace header string.\n
\n SenderId\n
For an IAM user, returns the IAM user ID, for example ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
\n SentTimestamp – Returns the time the message was sent to the queue (epoch time in milliseconds).
\n SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
\n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.
\n MessageGroupId – Returns the value provided by the producer that\n calls the \n SendMessage\n action. Messages with the\n same MessageGroupId are returned in sequence.
\n SequenceNumber – Returns the value provided by Amazon SQS.
A list of attributes that need to be returned along with each message. These\n attributes include:
\n\n All – Returns all values.
\n ApproximateFirstReceiveTimestamp – Returns the time the\n message was first received from the queue (epoch time in\n milliseconds).
\n ApproximateReceiveCount – Returns the number of times a\n message has been received across all queues but not deleted.
\n AWSTraceHeader – Returns the X-Ray trace\n header string.
\n SenderId\n
For a user, returns the user ID, for example\n ABCDEFGHI1JKLMNOPQ23R.
For an IAM role, returns the IAM role ID, for example\n ABCDE1F2GH3I4JK5LMNOP:i-a123b456.
\n SentTimestamp – Returns the time the message was sent to the\n queue (epoch time in\n milliseconds).
\n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
\n MessageDeduplicationId – Returns the value provided by the\n producer that calls the \n SendMessage\n \n action.
\n MessageGroupId – Returns the value provided by the\n producer that calls the \n SendMessage\n action.\n Messages with the same MessageGroupId are returned in\n sequence.
\n SequenceNumber – Returns the value provided by\n Amazon SQS.
The name of the message attribute, where N is the index.
\nThe name can contain alphanumeric characters and the underscore (_), hyphen (-), and period (.).
The name is case-sensitive and must be unique among all attribute names for the message.
\nThe name must not start with AWS-reserved prefixes such as AWS. or Amazon. (or any casing variants).
The name must not start or end with a period (.), and it should not have periods in succession (..).
The name can be up to 256 characters long.
\nWhen using ReceiveMessage, you can send a list of attribute names to receive, or you can return all of the attributes by specifying All or .* in your request. \n You can also use all message attributes starting with a prefix, for example bar.*.
The name of the message attribute, where N is the index.
\nThe name can contain alphanumeric characters and the underscore\n (_), hyphen (-), and period\n (.).
The name is case-sensitive and must be unique among all attribute names for\n the message.
\nThe name must not start with AWS-reserved prefixes such as AWS.\n or Amazon. (or any casing variants).
The name must not start or end with a period (.), and it should\n not have periods in succession (..).
The name can be up to 256 characters long.
\nWhen using ReceiveMessage, you can send a list of attribute names to\n receive, or you can return all of the attributes by specifying All or\n .* in your request. You can also use all message attributes starting\n with a prefix, for example bar.*.
The maximum number of messages to return. Amazon SQS never returns more messages than this value (however, fewer messages might be returned). Valid values: 1 to 10. Default: 1.
" + "smithy.api#documentation": "The maximum number of messages to return. Amazon SQS never returns more messages than this\n value (however, fewer messages might be returned). Valid values: 1 to 10. Default:\n 1.
" } }, "VisibilityTimeout": { - "target": "com.amazonaws.sqs#Integer", + "target": "com.amazonaws.sqs#NullableInteger", "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "The duration (in seconds) that the received messages are hidden from subsequent retrieve requests after being retrieved by a ReceiveMessage request.
The duration (in seconds) that the received messages are hidden from subsequent\n retrieve requests after being retrieved by a ReceiveMessage request.
The duration (in seconds) for which the call waits for a message to arrive in the queue before returning. If a message is available, the call returns sooner than WaitTimeSeconds.\n If no messages are available and the wait time expires, the call returns successfully with an empty list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for ReceiveMessage\n requests is longer than the WaitTimeSeconds parameter. For example,\n with the Java SDK, you can set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
The duration (in seconds) for which the call waits for a message to arrive in the\n queue before returning. If a message is available, the call returns sooner than\n WaitTimeSeconds. If no messages are available and the wait time\n expires, the call returns successfully with an empty list of messages.
To avoid HTTP errors, ensure that the HTTP response timeout for\n ReceiveMessage requests is longer than the\n WaitTimeSeconds parameter. For example, with the Java SDK, you can\n set HTTP transport settings using the NettyNioAsyncHttpClient for asynchronous clients, or the ApacheHttpClient for synchronous clients.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of ReceiveMessage calls. If a networking issue occurs after a ReceiveMessage action, and instead of a response you receive a generic error, \n it is possible to retry the same action with an identical ReceiveRequestAttemptId to retrieve the same set of messages, even if their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId only for 5 minutes after a ReceiveMessage action.
When you set FifoQueue, a caller of the ReceiveMessage action can provide a ReceiveRequestAttemptId explicitly.
If a caller of the ReceiveMessage action doesn't provide a ReceiveRequestAttemptId, Amazon SQS generates a ReceiveRequestAttemptId.
It is possible to retry the ReceiveMessage action with the same ReceiveRequestAttemptId if none of the messages have been modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same ReceiveRequestAttemptId return the same messages and receipt handles. If a retry occurs within the deduplication interval, \n it resets the visibility timeout. For more information, see\n Visibility Timeout\n in the Amazon SQS Developer Guide.
If a caller of the ReceiveMessage action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe threshold before the visibility timeout expires and extend the visibility timeout as necessary.
\nWhile messages with a particular MessageGroupId are invisible, no more messages belonging to the same MessageGroupId are returned until the visibility timeout expires. You can still receive\n messages with another MessageGroupId as long as it is also visible.
If a caller of ReceiveMessage can't track the ReceiveRequestAttemptId, no retries work until the original visibility timeout expires. As a result, delays might occur but\n the messages in the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId is 128 characters. ReceiveRequestAttemptId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see\n Using the ReceiveRequestAttemptId Request Parameter\n in the Amazon SQS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of ReceiveMessage calls. If a networking\n issue occurs after a ReceiveMessage action, and instead of a response you\n receive a generic error, it is possible to retry the same action with an identical\n ReceiveRequestAttemptId to retrieve the same set of messages, even if\n their visibility timeout has not yet expired.
You can use ReceiveRequestAttemptId only for 5 minutes after a\n ReceiveMessage action.
When you set FifoQueue, a caller of the\n ReceiveMessage action can provide a\n ReceiveRequestAttemptId explicitly.
If a caller of the ReceiveMessage action doesn't provide a\n ReceiveRequestAttemptId, Amazon SQS generates a\n ReceiveRequestAttemptId.
It is possible to retry the ReceiveMessage action with the same\n ReceiveRequestAttemptId if none of the messages have been\n modified (deleted or had their visibility changes).
During a visibility timeout, subsequent calls with the same\n ReceiveRequestAttemptId return the same messages and receipt\n handles. If a retry occurs within the deduplication interval, it resets the\n visibility timeout. For more information, see Visibility Timeout in the Amazon SQS Developer\n Guide.
If a caller of the ReceiveMessage action still processes\n messages when the visibility timeout expires and messages become visible,\n another worker consuming from the same queue can receive the same messages\n and therefore process duplicates. Also, if a consumer whose message\n processing time is longer than the visibility timeout tries to delete the\n processed messages, the action fails with an error.
To mitigate this effect, ensure that your application observes a safe\n threshold before the visibility timeout expires and extend the visibility\n timeout as necessary.
\nWhile messages with a particular MessageGroupId are invisible, no\n more messages belonging to the same MessageGroupId are returned\n until the visibility timeout expires. You can still receive messages with\n another MessageGroupId as long as it is also visible.
If a caller of ReceiveMessage can't track the\n ReceiveRequestAttemptId, no retries work until the original\n visibility timeout expires. As a result, delays might occur but the messages in\n the queue remain in a strict order.
The maximum length of ReceiveRequestAttemptId is 128 characters.\n ReceiveRequestAttemptId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using ReceiveRequestAttemptId, see Using the ReceiveRequestAttemptId Request Parameter in the Amazon SQS\n Developer Guide.
Revokes any permissions in the queue policy that matches the specified Label parameter.
Only the owner of a queue can remove permissions from it.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Revokes any permissions in the queue policy that matches the specified\n Label parameter.
Only the owner of a queue can remove permissions from it.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
The identification of the permission to remove. This is the label added using the \n AddPermission\n action.
The identification of the permission to remove. This is the label added using the\n \n AddPermission\n action.
The request was denied due to request throttling.
\nThe rate of requests per second exceeds the AWS KMS request quota for an\n account and Region.
\nA burst or sustained high rate of requests to change the state of the same KMS\n key. This condition is often known as a \"hot key.\"
\nRequests for operations on KMS keys in a Amazon Web Services CloudHSM key store\n might be throttled at a lower-than-expected rate when the Amazon Web Services\n CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is\n processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.
\nDelivers a message to the specified queue.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nDelivers a message to the specified queue.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nDelivers up to ten messages to the specified queue. This is a batch version of \n SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.
The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nIf you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses the default value for the queue.
Some actions take lists of parameters. These lists are specified using the param.n notation. Values of n are integers starting from 1. For example, a parameter list with two elements looks like this:
\n &AttributeName.1=first\n
\n &AttributeName.2=second\n
You can use SendMessageBatch to send up to 10 messages to the specified\n queue by assigning either identical or different values to each message (or by not\n assigning values at all). This is a batch version of \n SendMessage. For a FIFO queue, multiple messages within a single batch are enqueued\n in the order they are sent.
The result of sending each message is reported individually in the response.\n Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of 200.
The maximum allowed individual message size and the maximum total payload size (the\n sum of the individual lengths of all of the batched messages) are both 256 KiB (262,144\n bytes).
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nIf you don't specify the DelaySeconds parameter for an entry, Amazon SQS uses\n the default value for the queue.
The length of time, in seconds, for which a specific message is delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished.\n If you don't specify a value, the default value for the queue is applied.\n
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
The length of time, in seconds, for which a specific message is delayed. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue is applied.
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
The message system attribute to send Each message system attribute consists of a Name, Type, and Value.
Currently, the only supported message system attribute is AWSTraceHeader.\n Its type must be String and its value must be a correctly formatted\n X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
\nThe message system attribute to send Each message system attribute consists of a Name, Type, and Value.
Currently, the only supported message system attribute is AWSTraceHeader.\n Its type must be String and its value must be a correctly formatted\n X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
\nThis parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of messages within a 5-minute minimum deduplication interval. If a message with a particular \n MessageDeduplicationId is sent successfully, subsequent messages with the same MessageDeduplicationId are \n accepted successfully but aren't delivered. For more information, see \n Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon SQS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of messages within a 5-minute minimum deduplication\n interval. If a message with a particular MessageDeduplicationId is sent\n successfully, subsequent messages with the same MessageDeduplicationId are\n accepted successfully but aren't delivered. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a MessageDeduplicationId\n and you enable ContentBasedDeduplication for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the\n queue doesn't have ContentBasedDeduplication set, the\n action fails with an error.
If the queue has ContentBasedDeduplication set, your\n MessageDeduplicationId overrides the generated\n one.
When ContentBasedDeduplication is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled\n and then another message with a MessageDeduplicationId that is the\n same as the one generated for the first MessageDeduplicationId, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId after the deduplication\n interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe length of MessageDeduplicationId is 128 characters.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't \n specify a MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon SQS Developer Guide.
\n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If\n you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple\n MessageGroupId values. For each MessageGroupId,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.
A list of \n BatchResultErrorEntry\n items with error details about each message that can't be enqueued.
A list of \n BatchResultErrorEntry\n items with error\n details about each message that can't be enqueued.
For each message in the batch, the response contains a \n SendMessageBatchResultEntry\n tag if the message succeeds or a \n BatchResultErrorEntry\n tag if the message fails.
For each message in the batch, the response contains a \n SendMessageBatchResultEntry\n tag if the message succeeds or a\n \n BatchResultErrorEntry\n tag if the message\n fails.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber is 128 bits. As SequenceNumber continues to increase for a particular MessageGroupId.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber is 128 bits. As SequenceNumber\n continues to increase for a particular MessageGroupId.
The message to send. The minimum size is one character. The maximum size is 256 KB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\nThe message to send. The minimum size is one character. The maximum size is 256\n KiB.
\nA message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:
\n\n #x9 | #xA | #xD | #x20 to #xD7FF | #xE000 to #xFFFD | #x10000 to #x10FFFF\n
Any characters not included in this list will be rejected. For more information, see the W3C specification for characters.
\n\n The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished.\n If you don't specify a value, the default value for the queue applies.\n
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
The length of time, in seconds, for which to delay a specific message. Valid values:\n 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value\n become available for processing after the delay period is finished. If you don't specify\n a value, the default value for the queue applies.
When you set FifoQueue, you can't set DelaySeconds per message. You can set this parameter only on a queue level.
The message system attribute to send. Each message system attribute consists of a Name, Type, and Value.
Currently, the only supported message system attribute is AWSTraceHeader.\n Its type must be String and its value must be a correctly formatted\n X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
\nThe message system attribute to send. Each message system attribute consists of a Name, Type, and Value.
Currently, the only supported message system attribute is AWSTraceHeader.\n Its type must be String and its value must be a correctly formatted\n X-Ray trace header string.
The size of a message system attribute doesn't count towards the total size of a message.
\nThis parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of sent messages. If a message with a particular MessageDeduplicationId is sent successfully, any messages sent with the same MessageDeduplicationId \n are accepted successfully but aren't delivered during the 5-minute deduplication interval. For more information, see \n Exactly-once processing in the Amazon SQS Developer Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message is resent with the same \n MessageDeduplicationId after the deduplication interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe maximum length of MessageDeduplicationId is 128 characters. MessageDeduplicationId can contain alphanumeric characters (a-z, A-Z, 0-9) and \n punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see\n Using the MessageDeduplicationId Property\n in the Amazon SQS Developer Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe token used for deduplication of sent messages. If a message with a particular\n MessageDeduplicationId is sent successfully, any messages sent with the\n same MessageDeduplicationId are accepted successfully but aren't delivered\n during the 5-minute deduplication interval. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide.
Every message must have a unique MessageDeduplicationId,
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a MessageDeduplicationId\n and you enable ContentBasedDeduplication for your queue,\n Amazon SQS uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the message\n (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and the\n queue doesn't have ContentBasedDeduplication set, the\n action fails with an error.
If the queue has ContentBasedDeduplication set, your\n MessageDeduplicationId overrides the generated\n one.
When ContentBasedDeduplication is in effect, messages with\n identical content sent within the deduplication interval are treated as\n duplicates and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled\n and then another message with a MessageDeduplicationId that is the\n same as the one generated for the first MessageDeduplicationId, the\n two messages are treated as duplicates and only one copy of the message is\n delivered.
The MessageDeduplicationId is available to the consumer of the\n message (this can be useful for troubleshooting delivery issues).
If a message is sent successfully but the acknowledgement is lost and the message\n is resent with the same MessageDeduplicationId after the deduplication\n interval, Amazon SQS can't detect duplicate messages.
Amazon SQS continues to keep track of the message deduplication ID even after the message is received and deleted.
\nThe maximum length of MessageDeduplicationId is 128 characters.\n MessageDeduplicationId can contain alphanumeric characters\n (a-z, A-Z, 0-9) and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageDeduplicationId, see Using the MessageDeduplicationId Property in the Amazon SQS Developer\n Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple MessageGroupId values. For each MessageGroupId, the messages are sorted by time sent. The caller can't \n specify a MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values: alphanumeric characters and punctuation (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see\n Using the MessageGroupId Property\n in the Amazon SQS Developer Guide.
\n MessageGroupId is required for FIFO queues. You can't use it for Standard queues.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe tag that specifies that a message belongs to a specific message group. Messages\n that belong to the same message group are processed in a FIFO manner (however,\n messages in different message groups might be processed out of order). To interleave\n multiple ordered streams within a single queue, use MessageGroupId values\n (for example, session data for multiple users). In this scenario, multiple consumers can\n process the queue, but the session data of each user is processed in a FIFO\n fashion.
You must associate a non-empty MessageGroupId with a message. If\n you don't provide a MessageGroupId, the action fails.
\n ReceiveMessage might return messages with multiple\n MessageGroupId values. For each MessageGroupId,\n the messages are sorted by time sent. The caller can't specify a\n MessageGroupId.
The length of MessageGroupId is 128 characters. Valid values:\n alphanumeric characters and punctuation\n (!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~).
For best practices of using MessageGroupId, see Using the MessageGroupId Property in the Amazon SQS Developer\n Guide.
\n MessageGroupId is required for FIFO queues. You can't use it for\n Standard queues.
An attribute containing the MessageId of the message sent to the queue. For more information, see Queue and Message Identifiers\n in the Amazon SQS Developer Guide.\n
An attribute containing the MessageId of the message sent to the queue.\n For more information, see Queue and Message Identifiers in the Amazon SQS Developer\n Guide.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber is 128 bits. SequenceNumber continues to increase for a particular MessageGroupId.
This parameter applies only to FIFO (first-in-first-out) queues.
\nThe large, non-consecutive number that Amazon SQS assigns to each message.
\nThe length of SequenceNumber is 128 bits. SequenceNumber\n continues to increase for a particular MessageGroupId.
Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system. \n Changes made to the MessageRetentionPeriod attribute can take up to 15 minutes.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
Sets the value of one or more queue attributes. When you change a queue's attributes,\n the change can take up to 60 seconds for most of the attributes to propagate throughout\n the Amazon SQS system. Changes made to the MessageRetentionPeriod attribute can\n take up to 15 minutes and will impact existing messages in the queue potentially causing\n them to be expired and deleted if the MessageRetentionPeriod is reduced\n below the age of existing messages.
In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nTo remove the ability to change queue permissions, you must deny permission to the AddPermission, RemovePermission, and SetQueueAttributes actions in your IAM policy.
A map of attributes to set.
\nThe following lists the names, descriptions, and values of the special request parameters that the SetQueueAttributes action uses:
\n DelaySeconds – The length of time, in seconds, for which the delivery of all messages in the queue is delayed. Valid values: An integer from 0 to 900 (15 minutes). Default: 0.\n
\n MaximumMessageSize – The limit of how many bytes a message can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).\n
\n MessageRetentionPeriod – The length of time, in seconds, for which Amazon SQS retains a message. Valid values: An integer representing seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days).\n
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more information about policy structure, see Overview of Amazon Web Services IAM Policies \n in the Identity and Access Management User Guide.\n
\n ReceiveMessageWaitTimeSeconds – The length of time, in seconds, for which a \n ReceiveMessage\n action waits for a message to arrive. Valid values: An integer from 0 to 20 (seconds). Default: 0.\n
\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. For more information about the redrive policy and dead-letter queues, see Using Amazon SQS Dead-Letter Queues \n in the Amazon SQS Developer Guide.
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being moved to the dead-letter queue.\n When the ReceiveCount for a message exceeds the maxReceiveCount for a queue, Amazon SQS moves the message to the dead-letter-queue.
The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue.
\n\n VisibilityTimeout – The visibility timeout for the queue, in seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For more information about the visibility timeout,\n see Visibility Timeout in the Amazon SQS Developer Guide.
The following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms.\n While the alias of the AWS-managed CMK for Amazon SQS is always alias/aws/sqs, the alias of a custom CMK can, for example, be alias/MyAlias\n .\n For more examples, see KeyId in the Key Management Service API Reference.\n
\n KmsDataKeyReusePeriodSeconds – The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt \n or decrypt messages before calling KMS again. An integer representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24 hours). Default: 300 (5 minutes). A shorter time period provides better security \n but results in more calls to KMS which might incur charges after Free Tier. For more information, see \n How Does the Data Key Reuse Period Work?.\n
\n SqsManagedSseEnabled – Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (e.g. SSE-KMS or SSE-SQS).
The following attribute applies only to FIFO (first-in-first-out) queues:
\n\n ContentBasedDeduplication – Enables content-based deduplication. For more information, see Exactly-once processing in the \n Amazon SQS Developer Guide. Note the following:\n
Every message must have a unique MessageDeduplicationId.
You may provide a MessageDeduplicationId explicitly.
If you aren't able to provide a MessageDeduplicationId and you enable ContentBasedDeduplication for your queue, \n Amazon SQS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).\n
If you don't provide a MessageDeduplicationId and the queue doesn't have ContentBasedDeduplication set,\n the action fails with an error.
If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.
When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates \n and only one copy of the message is delivered.
If you send one message with ContentBasedDeduplication enabled and then another message with a MessageDeduplicationId that is the same \n as the one generated for the first MessageDeduplicationId, the two messages are treated as duplicates and only one copy of the message is delivered.\n
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", + "smithy.api#documentation": "A map of attributes to set.
\nThe following lists the names, descriptions, and values of the special request\n parameters that the SetQueueAttributes action uses:
\n DelaySeconds – The length of time, in seconds, for which the\n delivery of all messages in the queue is delayed. Valid values: An integer from\n 0 to 900 (15 minutes). Default: 0.
\n MaximumMessageSize – The limit of how many bytes a message\n can contain before Amazon SQS rejects it. Valid values: An integer from 1,024 bytes\n (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144 (256 KiB).
\n MessageRetentionPeriod – The length of time, in seconds, for\n which Amazon SQS retains a message. Valid values: An integer representing seconds,\n from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600 (4 days). When you\n change a queue's attributes, the change can take up to 60 seconds for most of\n the attributes to propagate throughout the Amazon SQS system. Changes made to the\n MessageRetentionPeriod attribute can take up to 15 minutes and\n will impact existing messages in the queue potentially causing them to be\n expired and deleted if the MessageRetentionPeriod is reduced below\n the age of existing messages.
\n Policy – The queue's policy. A valid Amazon Web Services policy. For more\n information about policy structure, see Overview of Amazon Web Services IAM\n Policies in the Identity and Access Management User\n Guide.
\n ReceiveMessageWaitTimeSeconds – The length of time, in\n seconds, for which a \n ReceiveMessage\n action waits\n for a message to arrive. Valid values: An integer from 0 to 20 (seconds).\n Default: 0.
\n VisibilityTimeout – The visibility timeout for the queue, in\n seconds. Valid values: An integer from 0 to 43,200 (12 hours). Default: 30. For\n more information about the visibility timeout, see Visibility Timeout in the Amazon SQS Developer\n Guide.
The following attributes apply only to dead-letter queues:\n
\n\n RedrivePolicy – The string that includes the parameters for the dead-letter queue functionality \n of the source queue as a JSON object. The parameters are as follows:
\n deadLetterTargetArn – The Amazon Resource Name (ARN) of the dead-letter queue to \n which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
\n maxReceiveCount – The number of times a message is delivered to the source queue before being \n moved to the dead-letter queue. Default: 10. When the ReceiveCount for a message exceeds the maxReceiveCount \n for a queue, Amazon SQS moves the message to the dead-letter-queue.
\n RedriveAllowPolicy – The string that includes the parameters for the permissions for the dead-letter\n queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows:
\n redrivePermission – The permission type that defines which source queues can \n specify the current queue as the dead-letter queue. Valid values are:
\n allowAll – (Default) Any source queues in this Amazon Web Services account in the same Region can \n specify this queue as the dead-letter queue.
\n denyAll – No source queues can specify this queue as the dead-letter\n queue.
\n byQueue – Only queues specified by the sourceQueueArns parameter can specify \n this queue as the dead-letter queue.
\n sourceQueueArns – The Amazon Resource Names (ARN)s of the source queues that can specify \n this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the \n redrivePermission parameter is set to byQueue. You can specify up to 10 source queue ARNs. \n To allow more than 10 source queues to specify dead-letter queues, set the redrivePermission parameter\n to allowAll.
The dead-letter queue of a \n FIFO queue must also be a FIFO queue. Similarly, the dead-letter \n queue of a standard queue must also be a standard queue.
\nThe following attributes apply only to server-side-encryption:
\n\n KmsMasterKeyId – The ID of an Amazon Web Services managed customer master\n key (CMK) for Amazon SQS or a custom CMK. For more information, see Key Terms. While the alias of the AWS-managed CMK for Amazon SQS is\n always alias/aws/sqs, the alias of a custom CMK can, for example,\n be alias/MyAlias\n . For more examples, see\n KeyId in the Key Management Service API\n Reference.
\n KmsDataKeyReusePeriodSeconds – The length of time, in\n seconds, for which Amazon SQS can reuse a data key to\n encrypt or decrypt messages before calling KMS again. An integer\n representing seconds, between 60 seconds (1 minute) and 86,400 seconds (24\n hours). Default: 300 (5 minutes). A shorter time period provides better security\n but results in more calls to KMS which might incur charges after Free Tier. For\n more information, see How Does the Data Key Reuse Period Work?.
\n SqsManagedSseEnabled – Enables server-side queue encryption\n using SQS owned encryption keys. Only one server-side encryption option is\n supported per queue (for example, SSE-KMS or SSE-SQS).
The following attribute applies only to FIFO (first-in-first-out)\n queues:
\n\n ContentBasedDeduplication – Enables content-based\n deduplication. For more information, see Exactly-once processing in the Amazon SQS Developer\n Guide. Note the following:
Every message must have a unique\n MessageDeduplicationId.
You may provide a MessageDeduplicationId\n explicitly.
If you aren't able to provide a\n MessageDeduplicationId and you enable\n ContentBasedDeduplication for your queue, Amazon SQS\n uses a SHA-256 hash to generate the\n MessageDeduplicationId using the body of the\n message (but not the attributes of the message).
If you don't provide a MessageDeduplicationId and\n the queue doesn't have ContentBasedDeduplication\n set, the action fails with an error.
If the queue has ContentBasedDeduplication set,\n your MessageDeduplicationId overrides the generated\n one.
When ContentBasedDeduplication is in effect, messages\n with identical content sent within the deduplication interval are\n treated as duplicates and only one copy of the message is\n delivered.
If you send one message with ContentBasedDeduplication\n enabled and then another message with a\n MessageDeduplicationId that is the same as the one\n generated for the first MessageDeduplicationId, the two\n messages are treated as duplicates and only one copy of the message is\n delivered.
The following attributes apply only to \nhigh throughput\nfor FIFO queues:
\n\n DeduplicationScope – Specifies whether message deduplication occurs at the \n message group or queue level. Valid values are messageGroup and queue.
\n FifoThroughputLimit – Specifies whether the FIFO queue throughput \n quota applies to the entire queue or per message group. Valid values are perQueue and perMessageGroupId. \n The perMessageGroupId value is allowed only when the value for DeduplicationScope is messageGroup.
To enable high throughput for FIFO queues, do the following:
\nSet DeduplicationScope to messageGroup.
Set FifoThroughputLimit to perMessageGroupId.
If you set these attributes to anything other than the values shown for enabling high\n throughput, normal throughput is in effect and deduplication occurs as specified.
\nFor information on throughput quotas, \n see Quotas related to messages \n in the Amazon SQS Developer Guide.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Attribute" @@ -3046,7 +3663,8 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "", + "smithy.api#input": {} } }, "com.amazonaws.sqs#String": { @@ -3093,8 +3711,25 @@ "output": { "target": "smithy.api#Unit" }, + "errors": [ + { + "target": "com.amazonaws.sqs#InvalidAddress" + }, + { + "target": "com.amazonaws.sqs#InvalidSecurity" + }, + { + "target": "com.amazonaws.sqs#QueueDoesNotExist" + }, + { + "target": "com.amazonaws.sqs#RequestThrottled" + }, + { + "target": "com.amazonaws.sqs#UnsupportedOperation" + } + ], "traits": { - "smithy.api#documentation": "Add cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\n \nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nAdd cost allocation tags to the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nWhen you use queue tags, keep the following guidelines in mind:
\nAdding more than 50 tags to a queue isn't recommended.
\nTags don't have any semantic meaning. Amazon SQS interprets tags as character strings.
\nTags are case-sensitive.
\nA new tag with a key identical to that of an existing tag overwrites the existing tag.
\nFor a full list of tag restrictions, see \nQuotas related to queues \nin the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\nRemove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a user name in the Amazon SQS Developer Guide.
\nRemove cost allocation tags from the specified Amazon SQS queue. For an overview, see Tagging \nYour Amazon SQS Queues in the Amazon SQS Developer Guide.
\nCross-account permissions don't apply to this action. For more information, \nsee Grant \ncross-account permissions to a role and a username in the Amazon SQS Developer Guide.
\n