Amazon GuardDuty is a continuous security monitoring service that analyzes and processes the following data sources: VPC Flow Logs, AWS CloudTrail event logs, and DNS logs. It uses threat intelligence feeds, such as lists of malicious IPs and domains, and machine learning to identify unexpected and potentially unauthorized and malicious activity within your AWS environment. This can include issues like escalations of privileges, uses of exposed credentials, or communication with malicious IPs, URLs, or domains. For example, GuardDuty can detect compromised EC2 instances serving malware or mining bitcoin. It also monitors AWS account access behavior for signs of compromise, such as unauthorized infrastructure deployments, like instances deployed in a region that has never been used, or unusual API calls, like a password policy change to reduce password strength. GuardDuty informs you of the status of your AWS environment by producing security findings that you can view in the GuardDuty console or through Amazon CloudWatch events. For more information, see Amazon GuardDuty User Guide.
", "operations": { "AcceptInvitation": "Accepts the invitation to be monitored by a master GuardDuty account.
", - "ArchiveFindings": "Archives Amazon GuardDuty findings specified by the list of finding IDs.
", - "CreateDetector": "Creates a single Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector must be created in order for GuardDuty to become operational.
", + "ArchiveFindings": "Archives GuardDuty findings specified by the list of finding IDs.
Only the master account can archive findings. Member accounts do not have permission to archive findings from their accounts.
Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each region that you enable the service. You can have only one detector per account per region.
", "CreateFilter": "Creates a filter using the specified finding criteria.
", "CreateIPSet": "Creates a new IPSet - a list of trusted IP addresses that have been whitelisted for secure communication with AWS infrastructure and applications.
", "CreateMembers": "Creates member accounts of the current AWS account by specifying a list of AWS account IDs. The current AWS account can then invite these members to manage GuardDuty in their accounts.
", @@ -25,7 +25,7 @@ "GetFindingsStatistics": "Lists Amazon GuardDuty findings' statistics for the specified detector ID.
", "GetIPSet": "Retrieves the IPSet specified by the IPSet ID.
", "GetInvitationsCount": "Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.
", - "GetMasterAccount": "Provides the details for the GuardDuty master account to the current GuardDuty member account.
", + "GetMasterAccount": "Provides the details for the GuardDuty master account associated with the current GuardDuty member account.
", "GetMembers": "Retrieves GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.
", "GetThreatIntelSet": "Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.
", "InviteMembers": "Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account.
", @@ -60,13 +60,13 @@ } }, "AccessKeyDetails": { - "base": null, + "base": "Contains information about the access keys.
", "refs": { "Resource$AccessKeyDetails": "The IAM access key details (IAM user information) of a user that engaged in the activity that prompted GuardDuty to generate a finding.
" } }, "AccountDetail": { - "base": null, + "base": "Contains information about the account.
", "refs": { "AccountDetails$member": null } @@ -83,7 +83,7 @@ "AccountDetail$AccountId": "Member account ID.
", "AccountIds$member": null, "Invitation$AccountId": "Inviter account ID
", - "Master$AccountId": "Master account ID
", + "Master$AccountId": "The ID of the account used as the Master account.
", "Member$AccountId": "Member account ID.
", "UnprocessedAccount$AccountId": "AWS Account ID.
" } @@ -102,7 +102,7 @@ } }, "Action": { - "base": null, + "base": "Contains information about action.
", "refs": { "Service$Action": "Information about the activity described in a finding.
" } @@ -118,7 +118,7 @@ } }, "AwsApiCallAction": { - "base": null, + "base": "Contains information about the API operation.
", "refs": { "Action$AwsApiCallAction": "Information about the AWS_API_CALL action described in this finding.
" } @@ -144,7 +144,7 @@ } }, "City": { - "base": null, + "base": "Contains information about the city associated with the IP address.
", "refs": { "RemoteIpDetails$City": "City information of the remote IP address.
" } @@ -159,7 +159,7 @@ } }, "Condition": { - "base": null, + "base": "Contains information about the condition.
", "refs": { "Criterion$value": null } @@ -171,7 +171,7 @@ } }, "Country": { - "base": null, + "base": "Contains information about the country.
", "refs": { "RemoteIpDetails$Country": "Country code of the remote IP address.
" } @@ -390,13 +390,13 @@ } }, "DnsRequestAction": { - "base": null, + "base": "Contains information about the DNS request.
", "refs": { "Action$DnsRequestAction": "Information about the DNS_REQUEST action described in this finding.
" } }, "DomainDetails": { - "base": null, + "base": "Contains information about the domain.
", "refs": { "AwsApiCallAction$DomainDetails": "Domain information for the AWS API call.
" } @@ -404,8 +404,8 @@ "Double": { "base": null, "refs": { - "Finding$Confidence": "The confidence level of a finding.
", - "Finding$Severity": "The severity of a finding.
", + "Finding$Confidence": "The confidence score for the finding.
", + "Finding$Severity": "The severity of the finding.
", "GeoLocation$Lat": "Latitude information of remote IP address.
", "GeoLocation$Lon": "Longitude information of remote IP address.
" } @@ -420,13 +420,19 @@ "Eq": { "base": null, "refs": { - "Condition$Eq": "Represents the equal condition to be applied to a single field when querying for findings.
" + "Condition$Eq": "Deprecated. Represents the equal condition to be applied to a single field when querying for findings.
" } }, "Equals": { "base": null, "refs": { - "Condition$Equals": null + "Condition$Equals": "Represents an equal condition to be applied to a single field when querying for findings.
" + } + }, + "Evidence": { + "base": "Contains information about the reason that the finding was generated.
", + "refs": { + "Service$Evidence": "An evidence object associated with the service.
" } }, "Feedback": { @@ -476,13 +482,13 @@ } }, "Finding": { - "base": null, + "base": "Contains information about the finding.
", "refs": { "Findings$member": null } }, "FindingCriteria": { - "base": null, + "base": "Contains finding criteria information.
", "refs": { "CreateFilterRequest$FindingCriteria": "Represents the criteria to be used in the filter for querying findings.
", "GetFilterResponse$FindingCriteria": "Represents the criteria to be used in the filter for querying findings.
", @@ -528,7 +534,7 @@ } }, "FindingStatistics": { - "base": null, + "base": "Contains information about finding statistics.
", "refs": { "GetFindingsStatisticsResponse$FindingStatistics": "Finding statistics object.
" } @@ -536,7 +542,7 @@ "FindingType": { "base": null, "refs": { - "Finding$Type": "The type of a finding described by the action.
", + "Finding$Type": "The type of the finding.
", "FindingTypes$member": null } }, @@ -553,7 +559,7 @@ } }, "GeoLocation": { - "base": null, + "base": "Contains information about the
", "refs": { "RemoteIpDetails$GeoLocation": "Location information of the remote IP address.
" } @@ -657,13 +663,13 @@ } }, "IamInstanceProfile": { - "base": null, + "base": "Contains information about the instance profile.
", "refs": { "InstanceDetails$IamInstanceProfile": "The profile information of the EC2 instance.
" } }, "InstanceDetails": { - "base": null, + "base": "Contains information about the details of an instance.
", "refs": { "Resource$InstanceDetails": "The information about the EC2 instance associated with the activity that prompted GuardDuty to generate a finding.
" } @@ -671,10 +677,10 @@ "Integer": { "base": null, "refs": { - "Condition$Gt": "Represents a greater than condition to be applied to a single field when querying for findings.
", - "Condition$Gte": "Represents a greater than equal condition to be applied to a single field when querying for findings.
", - "Condition$Lt": "Represents a less than condition to be applied to a single field when querying for findings.
", - "Condition$Lte": "Represents a less than equal condition to be applied to a single field when querying for findings.
", + "Condition$Gt": "Deprecated. Represents a greater than condition to be applied to a single field when querying for findings.
", + "Condition$Gte": "Deprecated. Represents a greater than equal condition to be applied to a single field when querying for findings.
", + "Condition$Lt": "Deprecated. Represents a less than condition to be applied to a single field when querying for findings.
", + "Condition$Lte": "Deprecated. Represents a less than equal condition to be applied to a single field when querying for findings.
", "CountBySeverity$value": null, "GetInvitationsCountResponse$InvitationsCount": "The number of received invitations.
", "LocalPortDetails$Port": "Port number of the local connection.
", @@ -688,7 +694,7 @@ } }, "Invitation": { - "base": null, + "base": "Contains information about the invitation.
", "refs": { "Invitations$member": null } @@ -815,7 +821,7 @@ } }, "LocalPortDetails": { - "base": null, + "base": "Contains information about the port for the local connection.
", "refs": { "NetworkConnectionAction$LocalPortDetails": "Local port information of the connection.
", "PortProbeDetail$LocalPortDetails": "Local port information of the connection.
" @@ -842,7 +848,7 @@ } }, "Master": { - "base": null, + "base": "Contains information about the Master account and invitation.
", "refs": { "GetMasterAccountResponse$Master": "Master account details.
" } @@ -860,7 +866,7 @@ } }, "Member": { - "base": null, + "base": "Continas information about the member account
", "refs": { "Members$member": null } @@ -886,17 +892,17 @@ "Neq": { "base": null, "refs": { - "Condition$Neq": "Represents the not equal condition to be applied to a single field when querying for findings.
" + "Condition$Neq": "Deprecated. Represents the not equal condition to be applied to a single field when querying for findings.
" } }, "NetworkConnectionAction": { - "base": null, + "base": "Contains information about the network connection.
", "refs": { "Action$NetworkConnectionAction": "Information about the NETWORK_CONNECTION action described in this finding.
" } }, "NetworkInterface": { - "base": null, + "base": "Contains information about the network interface.
", "refs": { "NetworkInterfaces$member": null } @@ -910,7 +916,7 @@ "NotEquals": { "base": null, "refs": { - "Condition$NotEquals": null + "Condition$NotEquals": "Represents an not equal condition to be applied to a single field when querying for findings.
" } }, "OrderBy": { @@ -920,19 +926,19 @@ } }, "Organization": { - "base": null, + "base": "Continas information about the organization.
", "refs": { "RemoteIpDetails$Organization": "ISP Organization information of the remote IP address.
" } }, "PortProbeAction": { - "base": null, + "base": "Contains information about the port probe.
", "refs": { "Action$PortProbeAction": "Information about the PORT_PROBE action described in this finding.
" } }, "PortProbeDetail": { - "base": null, + "base": "Contains information about the port probe details.
", "refs": { "PortProbeDetails$member": null } @@ -944,7 +950,7 @@ } }, "PrivateIpAddressDetails": { - "base": null, + "base": "Contains information about the private IP address.
", "refs": { "PrivateIpAddresses$member": null } @@ -956,7 +962,7 @@ } }, "ProductCode": { - "base": null, + "base": "Contains information about the product code.
", "refs": { "ProductCodes$member": null } @@ -968,7 +974,7 @@ } }, "RemoteIpDetails": { - "base": null, + "base": "Continas information about the remote IP address.
", "refs": { "AwsApiCallAction$RemoteIpDetails": "Remote IP information of the connection.
", "NetworkConnectionAction$RemoteIpDetails": "Remote IP information of the connection.
", @@ -976,19 +982,19 @@ } }, "RemotePortDetails": { - "base": null, + "base": "Contains information about the remote port.
", "refs": { "NetworkConnectionAction$RemotePortDetails": "Remote port information of the connection.
" } }, "Resource": { - "base": null, + "base": "Contains information about the resource.
", "refs": { - "Finding$Resource": "The AWS resource associated with the activity that prompted GuardDuty to generate a finding.
" + "Finding$Resource": null } }, "SecurityGroup": { - "base": null, + "base": "Contains information about the security group.
", "refs": { "SecurityGroups$member": null } @@ -1000,13 +1006,13 @@ } }, "Service": { - "base": null, + "base": "Contains information about the service.
", "refs": { - "Finding$Service": "Additional information assigned to the generated finding by GuardDuty.
" + "Finding$Service": null } }, "SortCriteria": { - "base": null, + "base": "Contains information about the criteria for sorting.
", "refs": { "GetFindingsRequest$SortCriteria": "Represents the criteria used for sorting findings.
", "ListFindingsRequest$SortCriteria": "Represents the criteria used for sorting findings.
" @@ -1061,16 +1067,16 @@ "DomainDetails$Domain": "Domain information for the AWS API call.
", "Eq$member": null, "Equals$member": null, - "Finding$AccountId": "AWS account ID where the activity occurred that prompted GuardDuty to generate a finding.
", - "Finding$Arn": "The ARN of a finding described by the action.
", - "Finding$CreatedAt": "The time stamp at which a finding was generated.
", - "Finding$Description": "The description of a finding.
", - "Finding$Id": "The identifier that corresponds to a finding described by the action.
", - "Finding$Partition": "The AWS resource partition.
", - "Finding$Region": "The AWS region where the activity occurred that prompted GuardDuty to generate a finding.
", - "Finding$SchemaVersion": "Findings' schema version.
", - "Finding$Title": "The title of a finding.
", - "Finding$UpdatedAt": "The time stamp at which a finding was last updated.
", + "Finding$AccountId": "The ID of the account in which the finding was generated.
", + "Finding$Arn": "The ARN for the finding.
", + "Finding$CreatedAt": "The time and date at which the finding was created.
", + "Finding$Description": "The description of the finding.
", + "Finding$Id": "The ID of the finding.
", + "Finding$Partition": "The partition associated with the finding.
", + "Finding$Region": "The Region in which the finding was generated.
", + "Finding$SchemaVersion": "The version of the schema used for the finding.
", + "Finding$Title": "The title for the finding.
", + "Finding$UpdatedAt": "The time and date at which the finding was laste updated.
", "GetDetectorResponse$CreatedAt": "Detector creation timestamp.
", "GetDetectorResponse$ServiceRole": "The GuardDuty service role.
", "GetDetectorResponse$UpdatedAt": "Detector last update timestamp.
", @@ -1113,7 +1119,7 @@ "LocalPortDetails$PortName": "Port name of the local connection.
", "Master$InvitationId": "This value is used to validate the master account to the member account.
", "Master$RelationshipStatus": "The status of the relationship between the master and member accounts.
", - "Master$InvitedAt": "Timestamp at which the invitation was sent
", + "Master$InvitedAt": "Timestamp at which the invitation was sent.
", "Member$MasterId": "Master account ID.
", "Member$RelationshipStatus": "The status of the relationship between the member and the master.
", "Member$InvitedAt": "Timestamp at which the invitation was sent
", @@ -1151,6 +1157,8 @@ "Tag$Key": "EC2 instance tag key.
", "Tag$Value": "EC2 instance tag value.
", "ThreatIntelSetIds$member": null, + "ThreatIntelligenceDetail$ThreatListName": "The name of the threat intelligence list that triggered the finding.
", + "ThreatNames$member": null, "UnprocessedAccount$Result": "A reason why the account hasn't been processed.
", "UpdateFilterRequest$FilterName": "The name of the filter.
", "UpdateFindingsFeedbackRequest$Comments": "Additional feedback about the GuardDuty findings.
", @@ -1159,7 +1167,7 @@ } }, "Tag": { - "base": null, + "base": "Contains information about the tag associated with the resource.
", "refs": { "Tags$member": null } @@ -1188,7 +1196,7 @@ "GetFilterResponse$Tags": "The tags of the filter resource.
", "GetIPSetResponse$Tags": "The tags of the IP set resource.
", "GetThreatIntelSetResponse$Tags": "The tags of the Threat List resource.
", - "ListTagsForResourceResponse$Tags": null, + "ListTagsForResourceResponse$Tags": "The tags associated with the resource.
", "TagResourceRequest$Tags": "The tags to be added to a resource.
" } }, @@ -1233,6 +1241,24 @@ "GetThreatIntelSetResponse$Status": "The status of threatIntelSet file uploaded.
" } }, + "ThreatIntelligenceDetail": { + "base": "An instance of a threat intelligence detail that constitutes evidence for the finding.
", + "refs": { + "ThreatIntelligenceDetails$member": null + } + }, + "ThreatIntelligenceDetails": { + "base": null, + "refs": { + "Evidence$ThreatIntelligenceDetails": "A list of threat intelligence details related to the evidence.
" + } + }, + "ThreatNames": { + "base": null, + "refs": { + "ThreatIntelligenceDetail$ThreatNames": "A list of names of the threats in the threat intelligence list that triggered the finding.
" + } + }, "UnarchiveFindingsRequest": { "base": null, "refs": { @@ -1244,7 +1270,7 @@ } }, "UnprocessedAccount": { - "base": null, + "base": "Contains information about the accounts that were not processed.
", "refs": { "UnprocessedAccounts$member": null } @@ -1255,7 +1281,7 @@ "CreateMembersResponse$UnprocessedAccounts": "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", "DeclineInvitationsResponse$UnprocessedAccounts": "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", "DeleteInvitationsResponse$UnprocessedAccounts": "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", - "DeleteMembersResponse$UnprocessedAccounts": "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", + "DeleteMembersResponse$UnprocessedAccounts": "The accounts that could not be processed.
", "DisassociateMembersResponse$UnprocessedAccounts": "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", "GetMembersResponse$UnprocessedAccounts": "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", "InviteMembersResponse$UnprocessedAccounts": "A list of objects containing the unprocessed account and a result string explaining why it was unprocessed.
", diff --git a/models/apis/iot/2015-05-28/api-2.json b/models/apis/iot/2015-05-28/api-2.json index a4e786beb03..c17b72b790b 100644 --- a/models/apis/iot/2015-05-28/api-2.json +++ b/models/apis/iot/2015-05-28/api-2.json @@ -7920,6 +7920,11 @@ "tableName":{"shape":"TableName"} } }, + "Qos":{ + "type":"integer", + "max":1, + "min":0 + }, "QueryMaxResults":{ "type":"integer", "max":500, @@ -8154,7 +8159,8 @@ ], "members":{ "roleArn":{"shape":"AwsArn"}, - "topic":{"shape":"TopicPattern"} + "topic":{"shape":"TopicPattern"}, + "qos":{"shape":"Qos"} } }, "Resource":{"type":"string"}, diff --git a/models/apis/iot/2015-05-28/docs-2.json b/models/apis/iot/2015-05-28/docs-2.json index fea5f19d281..d47dfbfd978 100644 --- a/models/apis/iot/2015-05-28/docs-2.json +++ b/models/apis/iot/2015-05-28/docs-2.json @@ -2407,7 +2407,7 @@ "Flag": { "base": null, "refs": { - "AttributePayload$merge": "Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.
To remove an attribute, call UpdateThing with an empty attribute value.
The merge attribute is only valid when calling UpdateThing.
Specifies whether the list of attributes provided in the AttributePayload is merged with the attributes stored in the registry, instead of overwriting them.
To remove an attribute, call UpdateThing with an empty attribute value.
The merge attribute is only valid when calling UpdateThing or UpdateThingGroup.
The identity to which the policy is attached.
", "DetachPolicyRequest$target": "The target from which the policy will be detached.
", - "ListAttachedPoliciesRequest$target": "The group for which the policies will be listed.
", + "ListAttachedPoliciesRequest$target": "The group or principal for which the policies will be listed.
", "PolicyTargets$member": null } }, @@ -4136,6 +4136,12 @@ "DynamoDBv2Action$putItem": "Specifies the DynamoDB table to which the message data will be written. For example:
{ \"dynamoDBv2\": { \"roleArn\": \"aws:iam:12341251:my-role\" \"putItem\": { \"tableName\": \"my-table\" } } }
Each attribute in the message payload will be written to a separate column in the DynamoDB database.
" } }, + "Qos": { + "base": null, + "refs": { + "RepublishAction$qos": "The Quality of Service (QoS) level to use when republishing messages.
" + } + }, "QueryMaxResults": { "base": null, "refs": { diff --git a/models/apis/mediaconvert/2017-08-29/api-2.json b/models/apis/mediaconvert/2017-08-29/api-2.json index f81d6857027..e0e709261d0 100644 --- a/models/apis/mediaconvert/2017-08-29/api-2.json +++ b/models/apis/mediaconvert/2017-08-29/api-2.json @@ -1297,7 +1297,7 @@ "locationName": "defaultSelection" }, "ExternalAudioFileInput": { - "shape": "__stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE", + "shape": "__stringPatternS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE", "locationName": "externalAudioFileInput" }, "LanguageCode": { @@ -1727,6 +1727,10 @@ "shape": "CmafInitializationVectorInManifest", "locationName": "initializationVectorInManifest" }, + "SpekeKeyProvider": { + "shape": "SpekeKeyProviderCmaf", + "locationName": "spekeKeyProvider" + }, "StaticKeyProvider": { "shape": "StaticKeyProvider", "locationName": "staticKeyProvider" @@ -1822,6 +1826,7 @@ "CmafKeyProviderType": { "type": "string", "enum": [ + "SPEKE", "STATIC_KEY" ] }, @@ -2163,6 +2168,10 @@ "shape": "ReservationPlanSettings", "locationName": "reservationPlanSettings" }, + "Status": { + "shape": "QueueStatus", + "locationName": "status" + }, "Tags": { "shape": "__mapOf__string", "locationName": "tags" @@ -3388,7 +3397,8 @@ "type": "string", "enum": [ "DISABLED", - "ENABLED" + "ENABLED", + "TRANSITION_DETECTION" ] }, "H264Settings": { @@ -3745,7 +3755,8 @@ "type": "string", "enum": [ "DISABLED", - "ENABLED" + "ENABLED", + "TRANSITION_DETECTION" ] }, "H265Settings": { @@ -4394,7 +4405,7 @@ "locationName": "denoiseFilter" }, "FileInput": { - "shape": "__stringPatternHttpHttpsS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL", + "shape": "__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL", "locationName": "fileInput" }, "FilterEnable": { @@ -6156,6 +6167,10 @@ "SpatialFilterSettings": { "shape": "NoiseReducerSpatialFilterSettings", "locationName": "spatialFilterSettings" + }, + "TemporalFilterSettings": { + "shape": "NoiseReducerTemporalFilterSettings", + "locationName": "temporalFilterSettings" } } }, @@ -6168,7 +6183,8 @@ "LANCZOS", "SHARPEN", "CONSERVE", - "SPATIAL" + "SPATIAL", + "TEMPORAL" ] }, "NoiseReducerFilterSettings": { @@ -6197,6 +6213,23 @@ } } }, + "NoiseReducerTemporalFilterSettings": { + "type": "structure", + "members": { + "AggressiveMode": { + "shape": "__integerMin0Max4", + "locationName": "aggressiveMode" + }, + "Speed": { + "shape": "__integerMinNegative1Max3", + "locationName": "speed" + }, + "Strength": { + "shape": "__integerMin0Max16", + "locationName": "strength" + } + } + }, "NotFoundException": { "type": "structure", "members": { @@ -6808,6 +6841,31 @@ } } }, + "SpekeKeyProviderCmaf": { + "type": "structure", + "members": { + "CertificateArn": { + "shape": "__stringPatternArnAwsUsGovAcm", + "locationName": "certificateArn" + }, + "DashSignaledSystemIds": { + "shape": "__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12", + "locationName": "dashSignaledSystemIds" + }, + "HlsSignaledSystemIds": { + "shape": "__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12", + "locationName": "hlsSignaledSystemIds" + }, + "ResourceId": { + "shape": "__stringPatternW", + "locationName": "resourceId" + }, + "Url": { + "shape": "__stringPatternHttps", + "locationName": "url" + } + } + }, "StaticKeyProvider": { "type": "structure", "members": { @@ -6877,9 +6935,23 @@ "PageNumber": { "shape": "__stringMin3Max3Pattern1809aFAF09aEAE", "locationName": "pageNumber" + }, + "PageTypes": { + "shape": "__listOfTeletextPageType", + "locationName": "pageTypes" } } }, + "TeletextPageType": { + "type": "string", + "enum": [ + "PAGE_TYPE_INITIAL", + "PAGE_TYPE_SUBTITLE", + "PAGE_TYPE_ADDL_INFO", + "PAGE_TYPE_PROGRAM_SCHEDULE", + "PAGE_TYPE_HEARING_IMPAIRED_SUBTITLE" + ] + }, "TeletextSourceSettings": { "type": "structure", "members": { @@ -7480,6 +7552,11 @@ "min": 0, "max": 3600 }, + "__integerMin0Max4": { + "type": "integer", + "min": 0, + "max": 4 + }, "__integerMin0Max47185920": { "type": "integer", "min": 0, @@ -7725,6 +7802,11 @@ "min": -180, "max": 180 }, + "__integerMinNegative1Max3": { + "type": "integer", + "min": -1, + "max": 3 + }, "__integerMinNegative2147483648Max2147483647": { "type": "integer", "min": -2147483648, @@ -7875,6 +7957,12 @@ "shape": "Queue" } }, + "__listOfTeletextPageType": { + "type": "list", + "member": { + "shape": "TeletextPageType" + } + }, "__listOf__integerMin1Max2147483647": { "type": "list", "member": { @@ -7905,6 +7993,12 @@ "shape": "__stringMin1" } }, + "__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12": { + "type": "list", + "member": { + "shape": "__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12" + } + }, "__listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12": { "type": "list", "member": { @@ -8014,6 +8108,12 @@ "max": 32, "pattern": "^[0-9a-fA-F]{32}$" }, + "__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12": { + "type": "string", + "min": 36, + "max": 36, + "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" + }, "__stringMin3Max3Pattern1809aFAF09aEAE": { "type": "string", "min": 3, @@ -8072,9 +8172,9 @@ "type": "string", "pattern": "^(\\d+(\\/\\d+)*)$" }, - "__stringPatternHttpHttpsS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL": { + "__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL": { "type": "string", - "pattern": "^(http|https|s3)://([^\\/]+\\/)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL])))$" + "pattern": "^(http|https|s3)://([^\\/]+\\/)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL])))$" }, "__stringPatternHttps": { "type": "string", @@ -8092,9 +8192,9 @@ "type": "string", "pattern": "^s3:\\/\\/.*\\/(ASSETMAP.xml)?$" }, - "__stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": { + "__stringPatternS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": { "type": "string", - "pattern": "^(s3:\\/\\/)([^\\/]+\\/)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))$" + "pattern": "^(s3:\\/\\/)([^\\/]+\\/)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))$" }, "__stringPatternSNManifestConfirmConditionNotificationNS": { "type": "string", @@ -8104,6 +8204,10 @@ "type": "string", "pattern": "^\\s*<(.|\\n)*SignalProcessingNotification(.|\\n)*>\\s*$" }, + "__stringPatternW": { + "type": "string", + "pattern": "^[\\w-]+$" + }, "__stringPatternWS": { "type": "string", "pattern": "^[\\w\\s]*$" diff --git a/models/apis/mediaconvert/2017-08-29/docs-2.json b/models/apis/mediaconvert/2017-08-29/docs-2.json index 751edf367e2..8b161a0f154 100644 --- a/models/apis/mediaconvert/2017-08-29/docs-2.json +++ b/models/apis/mediaconvert/2017-08-29/docs-2.json @@ -386,9 +386,9 @@ } }, "CmafEncryptionType": { - "base": "Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.", + "base": "For DRM with CMAF, the encryption type is always sample AES.", "refs": { - "CmafEncryptionSettings$EncryptionMethod": "Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption." + "CmafEncryptionSettings$EncryptionMethod": "For DRM with CMAF, the encryption type is always sample AES." } }, "CmafGroupSettings": { @@ -398,15 +398,15 @@ } }, "CmafInitializationVectorInManifest": { - "base": "The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.", + "base": "When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests.", "refs": { - "CmafEncryptionSettings$InitializationVectorInManifest": "The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest." + "CmafEncryptionSettings$InitializationVectorInManifest": "When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests." } }, "CmafKeyProviderType": { - "base": "Indicates which type of key provider is used for encryption.", + "base": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.", "refs": { - "CmafEncryptionSettings$Type": "Indicates which type of key provider is used for encryption." + "CmafEncryptionSettings$Type": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html." } }, "CmafManifestCompression": { @@ -452,27 +452,27 @@ } }, "ColorMetadata": { - "base": "Enable Insert color metadata (ColorMetadata) to include color metadata in this output. This setting is enabled by default.", + "base": "Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.", "refs": { - "VideoDescription$ColorMetadata": "Enable Insert color metadata (ColorMetadata) to include color metadata in this output. This setting is enabled by default." + "VideoDescription$ColorMetadata": "Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default." } }, "ColorSpace": { - "base": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value FOLLOW. The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, or if your input video is missing color space metadata that should be there, specify the accurate color space here. If you choose HDR10, you can also correct inaccurate color space coefficients, using the HDR master display information controls. You must also set Color space usage (ColorSpaceUsage) to FORCE for the service to use these values.", + "base": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value Follow (FOLLOW). The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, specify the accurate color space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering Display Color Volume static metadata isn't present in your video stream, or if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", "refs": { - "VideoSelector$ColorSpace": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value FOLLOW. The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, or if your input video is missing color space metadata that should be there, specify the accurate color space here. If you choose HDR10, you can also correct inaccurate color space coefficients, using the HDR master display information controls. You must also set Color space usage (ColorSpaceUsage) to FORCE for the service to use these values." + "VideoSelector$ColorSpace": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value Follow (FOLLOW). The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, specify the accurate color space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering Display Color Volume static metadata isn't present in your video stream, or if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr." } }, "ColorSpaceConversion": { - "base": "Determines if colorspace conversion will be performed. If set to _None_, no conversion will be performed. If _Force 601_ or _Force 709_ are selected, conversion will be performed for inputs with differing colorspaces. An input's colorspace can be specified explicitly in the \"Video Selector\":#inputs-video_selector if necessary.", + "base": "Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, and from SDR to HDR. The service doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output.", "refs": { - "ColorCorrector$ColorSpaceConversion": "Determines if colorspace conversion will be performed. If set to _None_, no conversion will be performed. If _Force 601_ or _Force 709_ are selected, conversion will be performed for inputs with differing colorspaces. An input's colorspace can be specified explicitly in the \"Video Selector\":#inputs-video_selector if necessary." + "ColorCorrector$ColorSpaceConversion": "Specify the color space you want for this output. The service supports conversion between HDR formats, between SDR formats, and from SDR to HDR. The service doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't upgrade the dynamic range. The converted video has an HDR format, but visually appears the same as an unconverted output." } }, "ColorSpaceUsage": { - "base": "There are two sources for color metadata, the input file and the job configuration (in the Color space and HDR master display informaiton settings). The Color space usage setting controls which takes precedence. FORCE: The system will use color metadata supplied by user, if any. If the user does not supply color metadata, the system will use data from the source. FALLBACK: The system will use color metadata from the source. If source has no color metadata, the system will use user-supplied color metadata values if available.", + "base": "There are two sources for color metadata, the input file and the job input settings Color space (ColorSpace) and HDR master display information settings(Hdr10Metadata). The Color space usage setting determines which takes precedence. Choose Force (FORCE) to use color metadata from the input job settings. If you don't specify values for those settings, the service defaults to using metadata from your input. FALLBACK - Choose Fallback (FALLBACK) to use color metadata from the source when it is present. If there's no color metadata in your input file, the service defaults to using values you specify in the input settings.", "refs": { - "VideoSelector$ColorSpaceUsage": "There are two sources for color metadata, the input file and the job configuration (in the Color space and HDR master display informaiton settings). The Color space usage setting controls which takes precedence. FORCE: The system will use color metadata supplied by user, if any. If the user does not supply color metadata, the system will use data from the source. FALLBACK: The system will use color metadata from the source. If source has no color metadata, the system will use user-supplied color metadata values if available." + "VideoSelector$ColorSpaceUsage": "There are two sources for color metadata, the input file and the job input settings Color space (ColorSpace) and HDR master display information settings(Hdr10Metadata). The Color space usage setting determines which takes precedence. Choose Force (FORCE) to use color metadata from the input job settings. If you don't specify values for those settings, the service defaults to using metadata from your input. FALLBACK - Choose Fallback (FALLBACK) to use color metadata from the source when it is present. If there's no color metadata in your input file, the service defaults to using values you specify in the input settings." } }, "Commitment": { @@ -1127,9 +1127,9 @@ } }, "H264SceneChangeDetect": { - "base": "Scene change detection (inserts I-frames on scene changes).", + "base": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.", "refs": { - "H264Settings$SceneChangeDetect": "Scene change detection (inserts I-frames on scene changes)." + "H264Settings$SceneChangeDetect": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr." } }, "H264Settings": { @@ -1235,9 +1235,9 @@ } }, "H265InterlaceMode": { - "base": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose.", + "base": "Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) to create an interlaced output with the same field polarity as the source. If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\". If the source is progressive, your output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose. If you don't choose a value, the service will default to Progressive (PROGRESSIVE).", "refs": { - "H265Settings$InterlaceMode": "Use Interlace mode (InterlaceMode) to choose the scan line type for the output. * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce interlaced output with the entire output having the same field polarity (top or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, behavior depends on the input scan type.\n - If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\".\n - If the source is progressive, the output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose." + "H265Settings$InterlaceMode": "Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) to create an interlaced output with the same field polarity as the source. If the source is interlaced, the output will be interlaced with the same polarity as the source (it will follow the source). The output could therefore be a mix of \"top field first\" and \"bottom field first\". If the source is progressive, your output will be interlaced with \"top field first\" or \"bottom field first\" polarity, depending on which of the Follow options you chose. If you don't choose a value, the service will default to Progressive (PROGRESSIVE)." } }, "H265ParControl": { @@ -1271,9 +1271,9 @@ } }, "H265SceneChangeDetect": { - "base": "Scene change detection (inserts I-frames on scene changes).", + "base": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.", "refs": { - "H265Settings$SceneChangeDetect": "Scene change detection (inserts I-frames on scene changes)." + "H265Settings$SceneChangeDetect": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr." } }, "H265Settings": { @@ -1331,10 +1331,10 @@ } }, "Hdr10Metadata": { - "base": "Use the \"HDR master display information\" (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. These values vary depending on the input video and must be provided by a color grader. Range is 0 to 50,000; each increment represents 0.00002 in CIE1931 color coordinate. Note that these settings are not color correction. Note that if you are creating HDR outputs inside of an HLS CMAF package, to comply with the Apple specification, you must use the following settings. Set \"MP4 packaging type\" (writeMp4PackagingType) to HVC1 (HVC1). Set \"Profile\" (H265Settings > codecProfile) to Main10/High (MAIN10_HIGH). Set \"Level\" (H265Settings > codecLevel) to 5 (LEVEL_5).", + "base": "Use these settings to specify static color calibration metadata, as defined by SMPTE ST 2086. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator.", "refs": { - "ColorCorrector$Hdr10Metadata": "Use the HDR master display (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. Note that these settings are not color correction.", - "VideoSelector$Hdr10Metadata": "Use the \"HDR master display information\" (Hdr10Metadata) settings to correct HDR metadata or to provide missing metadata. These values vary depending on the input video and must be provided by a color grader. Range is 0 to 50,000; each increment represents 0.00002 in CIE1931 color coordinate. Note that these settings are not color correction. Note that if you are creating HDR outputs inside of an HLS CMAF package, to comply with the Apple specification, you must use the following settings. Set \"MP4 packaging type\" (writeMp4PackagingType) to HVC1 (HVC1). Set \"Profile\" (H265Settings > codecProfile) to Main10/High (MAIN10_HIGH). Set \"Level\" (H265Settings > codecLevel) to 5 (LEVEL_5)." + "ColorCorrector$Hdr10Metadata": "Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator. When you set Color space conversion (ColorSpaceConversion) to HDR 10 (FORCE_HDR10), these settings are required. You must set values for Max frame average light level (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", + "VideoSelector$Hdr10Metadata": "Use these settings to provide HDR 10 metadata that is missing or inaccurate in your input video. Appropriate values vary depending on the input video and must be provided by a color grader. The color grader generates these values during the HDR 10 mastering process. The valid range for each of these settings is 0 to 50,000. Each increment represents 0.00002 in CIE1931 color coordinate. Related settings - When you specify these values, you must also set Color space (ColorSpace) to HDR 10 (HDR10). To specify whether the the values you specify here take precedence over the values in the metadata of your input file, set Color space usage (ColorSpaceUsage). To specify whether color metadata is included in an output, set Color metadata (ColorMetadata). For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr." } }, "HlsAdMarkers": { @@ -1416,9 +1416,9 @@ } }, "HlsKeyProviderType": { - "base": "Indicates which type of key provider is used for encryption.", + "base": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.", "refs": { - "HlsEncryptionSettings$Type": "Indicates which type of key provider is used for encryption." + "HlsEncryptionSettings$Type": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html." } }, "HlsManifestCompression": { @@ -1955,9 +1955,9 @@ } }, "Mpeg2SceneChangeDetect": { - "base": "Scene change detection (inserts I-frames on scene changes).", + "base": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default.", "refs": { - "Mpeg2Settings$SceneChangeDetect": "Scene change detection (inserts I-frames on scene changes)." + "Mpeg2Settings$SceneChangeDetect": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default." } }, "Mpeg2Settings": { @@ -2034,9 +2034,9 @@ } }, "NoiseReducerFilter": { - "base": "Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral is an edge preserving noise reduction filter. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) are convolution filters. * Conserve is a min/max noise reduction filter. * Spatial is a frequency-domain filter based on JND principles.", + "base": "Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral preserves edges while reducing noise. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) do convolution filtering. * Conserve does min/max noise reduction. * Spatial does frequency-domain filtering based on JND principles. * Temporal optimizes video quality for complex motion.", "refs": { - "NoiseReducer$Filter": "Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral is an edge preserving noise reduction filter. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) are convolution filters. * Conserve is a min/max noise reduction filter. * Spatial is a frequency-domain filter based on JND principles." + "NoiseReducer$Filter": "Use Noise reducer filter (NoiseReducerFilter) to select one of the following spatial image filtering functions. To use this setting, you must also enable Noise reducer (NoiseReducer). * Bilateral preserves edges while reducing noise. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) do convolution filtering. * Conserve does min/max noise reduction. * Spatial does frequency-domain filtering based on JND principles. * Temporal optimizes video quality for complex motion." } }, "NoiseReducerFilterSettings": { @@ -2051,6 +2051,12 @@ "NoiseReducer$SpatialFilterSettings": "Noise reducer filter settings for spatial filter." } }, + "NoiseReducerTemporalFilterSettings": { + "base": "Noise reducer filter settings for temporal filter.", + "refs": { + "NoiseReducer$TemporalFilterSettings": "Noise reducer filter settings for temporal filter." + } + }, "NotFoundException": { "base": null, "refs": { @@ -2215,6 +2221,7 @@ "QueueStatus": { "base": "Queues can be ACTIVE or PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause a queue continue to run until they finish or result in an error.", "refs": { + "CreateQueueRequest$Status": "Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.", "Queue$Status": "Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.", "UpdateQueueRequest$Status": "Pause or activate a queue by changing its status between ACTIVE and PAUSED. If you pause a queue, jobs in that queue won't begin. Jobs that are running when you pause the queue continue to run until they finish or result in an error." } @@ -2312,11 +2319,17 @@ } }, "SpekeKeyProvider": { - "base": "Settings for use with a SPEKE key provider", + "base": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is HLS, MS Smooth, or DASH. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.", + "refs": { + "DashIsoEncryptionSettings$SpekeKeyProvider": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is HLS, MS Smooth, or DASH. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.", + "HlsEncryptionSettings$SpekeKeyProvider": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is HLS, MS Smooth, or DASH. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.", + "MsSmoothEncryptionSettings$SpekeKeyProvider": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is HLS, MS Smooth, or DASH. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead." + } + }, + "SpekeKeyProviderCmaf": { + "base": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is CMAF. If your output group type is HLS, MS Smooth, or DASH, use the SpekeKeyProvider settings instead.", "refs": { - "DashIsoEncryptionSettings$SpekeKeyProvider": "Settings for use with a SPEKE key provider", - "HlsEncryptionSettings$SpekeKeyProvider": "Settings for use with a SPEKE key provider", - "MsSmoothEncryptionSettings$SpekeKeyProvider": "Settings for use with a SPEKE key provider" + "CmafEncryptionSettings$SpekeKeyProvider": "Use these settings when doing DRM encryption with a SPEKE-compliant key provider, if your output group type is CMAF. If your output group type is HLS, MS Smooth, or DASH, use the SpekeKeyProvider settings instead." } }, "StaticKeyProvider": { @@ -2352,6 +2365,12 @@ "CaptionDestinationSettings$TeletextDestinationSettings": "Settings for Teletext caption output" } }, + "TeletextPageType": { + "base": "A page type as defined in the standard ETSI EN 300 468, Table 94", + "refs": { + "__listOfTeletextPageType$member": null + } + }, "TeletextSourceSettings": { "base": "Settings specific to Teletext caption sources, including Page number.", "refs": { @@ -2658,7 +2677,8 @@ "__integerMin0Max16": { "base": null, "refs": { - "NoiseReducerSpatialFilterSettings$Strength": "Relative strength of noise reducing filter. Higher values produce stronger filtering." + "NoiseReducerSpatialFilterSettings$Strength": "Relative strength of noise reducing filter. Higher values produce stronger filtering.", + "NoiseReducerTemporalFilterSettings$Strength": "Relative strength of noise reducing filter. Higher values produce stronger filtering. Recommended Range: * [0 .. 2] for complexity reduction with minimal sharpness loss * [2 .. 8] for complexity reduction with image preservation * [8 .. 16] for noise reduction. Reduce noise combined high complexity reduction" } }, "__integerMin0Max2147483647": { @@ -2731,6 +2751,12 @@ "HlsGroupSettings$ProgramDateTimePeriod": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds." } }, + "__integerMin0Max4": { + "base": null, + "refs": { + "NoiseReducerTemporalFilterSettings$AggressiveMode": "Use Aggressive mode for content that has complex motion. Higher values produce stronger temporal filtering. This filters highly complex scenes more aggressively and creates better VQ for low bitrate outputs." + } + }, "__integerMin0Max47185920": { "base": null, "refs": { @@ -2760,8 +2786,8 @@ "base": null, "refs": { "DvbNitSettings$NetworkId": "The numeric value placed in the Network Information Table (NIT).", - "Hdr10Metadata$MaxContentLightLevel": "Maximum light level among all samples in the coded video sequence, in units of candelas per square meter.", - "Hdr10Metadata$MaxFrameAverageLightLevel": "Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter.", + "Hdr10Metadata$MaxContentLightLevel": "Maximum light level among all samples in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content.", + "Hdr10Metadata$MaxFrameAverageLightLevel": "Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content.", "M2tsSettings$ProgramNumber": "Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.", "M2tsSettings$TransportStreamId": "Specify the ID for the transport stream itself in the program map table for this output. Transport stream IDs and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.", "M3u8Settings$ProgramNumber": "The value of the program number field in the Program Map Table.", @@ -2963,14 +2989,14 @@ "base": null, "refs": { "AncillarySourceSettings$SourceAncillaryChannelNumber": "Specifies the 608 channel number in the ancillary data track from which to extract captions. Unused for passthrough.", - "EmbeddedDestinationSettings$Destination608ChannelNumber": "Ignore this setting unless your input captions are SCC format. With SCC inputs, you can optionally use this setting to replace the input channel number with the channel number that you specify. Specify a different number for each output captions track for a particular output. If you don't specify an output channel number, the system uses the input channel number for the output channel number. You can optionally combine two captions channels in your output. The two output channel numbers can be one of the following pairs: 1,3; 2,4; 1,4; or 2,3.", + "EmbeddedDestinationSettings$Destination608ChannelNumber": "Ignore this setting unless your input captions are SCC format and your output captions are embedded in the video stream. Specify a CC number for each captions channel in this output. If you have two channels, pick CC numbers that aren't in the same field. For example, choose 1 and 3. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded.", "EmbeddedSourceSettings$Source608ChannelNumber": "Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough." } }, "__integerMin1Max6": { "base": null, "refs": { - "EmbeddedDestinationSettings$Destination708ServiceNumber": "Ignore this setting unless your input captions are SCC format and you are performing SCC upconvert. With SCC inputs, you can optionally use this setting to specify the 708 service number that is in the output. Specify a different service number for each output captions track for a particular output. If you don't specify an output track number, the system uses the 608 channel number for the output 708 service number. You can combine two captions channels in your output. Service numbers must be distinct.", + "EmbeddedDestinationSettings$Destination708ServiceNumber": "Ignore this setting unless your input captions are SCC format and you want both 608 and 708 captions embedded in your output stream. Optionally, specify the 708 service number for each output captions channel. Choose a different number for each channel. To use this setting, also set Force 608 to 708 upconvert (Convert608To708) to Upconvert (UPCONVERT) in your input captions selector settings. If you choose to upconvert but don't specify a 708 service number, MediaConvert uses the number you specify for CC channel number (destination608ChannelNumber) for the 708 service number. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded.", "H264Settings$NumberReferenceFrames": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", "H265Settings$NumberReferenceFrames": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding." } @@ -3111,6 +3137,12 @@ "ColorCorrector$Hue": "Hue in degrees." } }, + "__integerMinNegative1Max3": { + "base": null, + "refs": { + "NoiseReducerTemporalFilterSettings$Speed": "The speed of the filter (higher number is faster). Low setting reduces bit rate at the cost of transcode time, high setting improves transcode time at the cost of bit rate." + } + }, "__integerMinNegative2147483648Max2147483647": { "base": null, "refs": { @@ -3284,6 +3316,12 @@ "ListQueuesResponse$Queues": "List of queues." } }, + "__listOfTeletextPageType": { + "base": null, + "refs": { + "TeletextDestinationSettings$PageTypes": "Specify the page types for this Teletext page. If you don't specify a value here, the service sets the page type to the default value Subtitle (PAGE_TYPE_SUBTITLE). If you pass through the entire set of Teletext data, don't use this field. When you pass through a set of Teletext pages, your output has the same page types as your input." + } + }, "__listOf__integerMin1Max2147483647": { "base": null, "refs": { @@ -3317,10 +3355,17 @@ "AudioSelectorGroup$AudioSelectorNames": "Name of an Audio Selector within the same input to include in the group. Audio selector names are standardized, based on their order within the input (e.g., \"Audio Selector 1\"). The audio selector name parameter can be repeated to add any number of audio selectors to the group." } }, + "__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12": { + "base": null, + "refs": { + "SpekeKeyProviderCmaf$DashSignaledSystemIds": "Specify the DRM system IDs that you want signaled in the DASH manifest that MediaConvert creates as part of this CMAF package. The DASH manifest can currently signal up to three system IDs. For more information, see https://dashif.org/identifiers/content_protection/.", + "SpekeKeyProviderCmaf$HlsSignaledSystemIds": "Specify the DRM system ID that you want signaled in the HLS manifest that MediaConvert creates as part of this CMAF package. The HLS manifest can currently signal only one system ID. For more information, see https://dashif.org/identifiers/content_protection/." + } + }, "__listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12": { "base": null, "refs": { - "SpekeKeyProvider$SystemIds": "Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids. Other group types support one system id." + "SpekeKeyProvider$SystemIds": "Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids. Other group types support one system id. See\n https://dashif.org/identifiers/content_protection/ for more details." } }, "__listOf__stringPatternS3ASSETMAPXml": { @@ -3368,8 +3413,8 @@ "AssociateCertificateRequest$Arn": "The ARN of the ACM certificate that you want to associate with your MediaConvert resource.", "AudioDescription$AudioSourceName": "Specifies which audio data to use from each input. In the simplest case, specify an \"Audio Selector\":#inputs-audio_selector by name based on its order within each input. For example if you specify \"Audio Selector 3\", then the third audio selector will be used from each input. If an input does not have an \"Audio Selector 3\", then the audio selector marked as \"default\" in that input will be used. If there is no audio selector marked as \"default\", silence will be inserted for the duration of that input. Alternatively, an \"Audio Selector Group\":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then \"Audio Selector 1\" will be chosen automatically.", "CancelJobRequest$Id": "The Job ID of the job to be cancelled.", - "CaptionDescription$LanguageDescription": "Human readable information to indicate captions available for players (eg. English, or Spanish). Alphanumeric characters, spaces, and underscore are legal.", - "CaptionDescriptionPreset$LanguageDescription": "Human readable information to indicate captions available for players (eg. English, or Spanish). Alphanumeric characters, spaces, and underscore are legal.", + "CaptionDescription$LanguageDescription": "Specify a label for this set of output captions. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.", + "CaptionDescriptionPreset$LanguageDescription": "Specify a label for this set of output captions. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.", "CmafGroupSettings$BaseUrl": "A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.", "CreateJobRequest$ClientRequestToken": "Idempotency token for CreateJob operation.", "CreateJobRequest$JobTemplate": "When you create a job, you can either specify a job template or specify the transcoding settings individually", @@ -3438,7 +3483,7 @@ "Queue$Description": "An optional description that you create for each queue.", "Queue$Name": "A name that you create for each queue. Each name must be unique within your account.", "ResourceTags$Arn": "The Amazon Resource Name (ARN) of the resource.", - "SpekeKeyProvider$ResourceId": "The SPEKE-compliant server uses Resource ID (ResourceId) to identify content.", + "SpekeKeyProvider$ResourceId": "Specify the resource ID that your SPEKE-compliant key provider uses to identify this content.", "StaticKeyProvider$Url": "Relates to DRM implementation. The location of the license server used for protecting content.", "TagResourceRequest$Arn": "The Amazon Resource Name (ARN) of the resource that you want to tag. To get the ARN, send a GET request with the resource name.", "UntagResourceRequest$Arn": "The Amazon Resource Name (ARN) of the resource that you want to remove tags from. To get the ARN, send a GET request with the resource name.", @@ -3526,6 +3571,12 @@ "HlsEncryptionSettings$ConstantInitializationVector": "This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default." } }, + "__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12": { + "base": null, + "refs": { + "__listOf__stringMin36Max36Pattern09aFAF809aFAF409aFAF409aFAF409aFAF12$member": null + } + }, "__stringMin3Max3Pattern1809aFAF09aEAE": { "base": null, "refs": { @@ -3599,7 +3650,8 @@ "__stringPatternArnAwsUsGovAcm": { "base": null, "refs": { - "SpekeKeyProvider$CertificateArn": "Optional AWS Certificate Manager ARN for a certificate to send to the keyprovider. The certificate holds a key used by the keyprovider to encrypt the keys in its response." + "SpekeKeyProvider$CertificateArn": "If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here.", + "SpekeKeyProviderCmaf$CertificateArn": "If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here." } }, "__stringPatternArnAwsUsGovCnKmsAZ26EastWestCentralNorthSouthEastWest1912D12KeyAFAF098AFAF094AFAF094AFAF094AFAF0912": { @@ -3614,7 +3666,7 @@ "StaticKeyProvider$KeyFormatVersions": "Relates to DRM implementation. Either a single positive integer version value or a slash delimited list of version values (1/2/3)." } }, - "__stringPatternHttpHttpsS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL": { + "__stringPatternHttpHttpsS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL": { "base": null, "refs": { "Input$FileInput": "Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, \"s3://bucket/vf/cpl.xml\". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL." @@ -3623,7 +3675,8 @@ "__stringPatternHttps": { "base": null, "refs": { - "SpekeKeyProvider$Url": "Use URL (Url) to specify the SPEKE-compliant server that will provide keys for content." + "SpekeKeyProvider$Url": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content.", + "SpekeKeyProviderCmaf$Url": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content." } }, "__stringPatternIdentityAZaZ26AZaZ09163": { @@ -3648,7 +3701,7 @@ "__listOf__stringPatternS3ASSETMAPXml$member": null } }, - "__stringPatternS3MM2VVMMPPEEGGAAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": { + "__stringPatternS3MM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": { "base": null, "refs": { "AudioSelector$ExternalAudioFileInput": "Specifies audio data from an external file source." @@ -3666,10 +3719,16 @@ "EsamSignalProcessingNotification$SccXml": "Provide your ESAM SignalProcessingNotification XML document inside your JSON job settings. Form the XML document as per OC-SP-ESAM-API-I03-131025. The transcoder will use the signal processing instructions in the message that you supply. Provide your ESAM SignalProcessingNotification XML document inside your JSON job settings. For your MPEG2-TS file outputs, if you want the service to place SCTE-35 markers at the insertion points you specify in the XML document, you must also enable SCTE-35 ESAM (scte35Esam). Note that you can either specify an ESAM XML document or enable SCTE-35 passthrough. You can't do both." } }, + "__stringPatternW": { + "base": null, + "refs": { + "SpekeKeyProviderCmaf$ResourceId": "Specify the resource ID that your SPEKE-compliant key provider uses to identify this content." + } + }, "__stringPatternWS": { "base": null, "refs": { - "AudioDescription$StreamName": "Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary). Alphanumeric characters, spaces, and underscore are legal." + "AudioDescription$StreamName": "Specify a label for this output audio stream. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting." } }, "__timestampUnix": { diff --git a/models/apis/redshift/2012-12-01/api-2.json b/models/apis/redshift/2012-12-01/api-2.json index 28fd063f65f..ab0371fd339 100644 --- a/models/apis/redshift/2012-12-01/api-2.json +++ b/models/apis/redshift/2012-12-01/api-2.json @@ -1700,6 +1700,8 @@ "DeferredMaintenanceWindows":{"shape":"DeferredMaintenanceWindowsList"}, "SnapshotScheduleIdentifier":{"shape":"String"}, "SnapshotScheduleState":{"shape":"ScheduleState"}, + "ExpectedNextSnapshotScheduleTime":{"shape":"TStamp"}, + "ExpectedNextSnapshotScheduleTimeStatus":{"shape":"String"}, "ResizeInfo":{"shape":"ResizeInfo"} }, "wrapper":true diff --git a/models/apis/redshift/2012-12-01/docs-2.json b/models/apis/redshift/2012-12-01/docs-2.json index f504bb56425..7451bbcfad1 100644 --- a/models/apis/redshift/2012-12-01/docs-2.json +++ b/models/apis/redshift/2012-12-01/docs-2.json @@ -54,7 +54,7 @@ "DescribeResize": "Returns information about the last resize operation for the specified cluster. If no resize operation has ever been initiated for the specified cluster, a HTTP 404 error is returned. If a resize operation was initiated and completed, the status of the resize remains as SUCCEEDED until the next resize.
A resize operation can be requested using ModifyCluster and specifying a different number or type of nodes for the cluster.
", "DescribeSnapshotCopyGrants": "Returns a list of snapshot copy grants owned by the AWS account in the destination region.
For more information about managing snapshot copy grants, go to Amazon Redshift Database Encryption in the Amazon Redshift Cluster Management Guide.
", "DescribeSnapshotSchedules": "Returns a list of snapshot schedules.
", - "DescribeStorage": "Returns the total amount of snapshot usage and provisioned storage for a user in megabytes.
", + "DescribeStorage": "Returns the total amount of snapshot usage and provisioned storage in megabytes.
", "DescribeTableRestoreStatus": "Lists the status of one or more table restore requests made using the RestoreTableFromClusterSnapshot API action. If you don't specify a value for the TableRestoreRequestId parameter, then DescribeTableRestoreStatus returns the status of all table restore requests ordered by the date and time of the request in ascending order. Otherwise DescribeTableRestoreStatus returns the status of the table specified by TableRestoreRequestId.
Returns a list of tags. You can return tags from a specific resource by specifying an ARN, or you can return all tags for a given type of resource, such as clusters, snapshots, and so on.
The following are limitations for DescribeTags:
You cannot specify an ARN and a resource-type value together in the same request.
You cannot use the MaxRecords and Marker parameters together with the ARN parameter.
The MaxRecords parameter can be a range from 10 to 50 results to return in a request.
If you specify both tag keys and tag values in the same request, Amazon Redshift returns all resources that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all resources that have any combination of those values are returned.
If both tag keys and values are omitted from the request, resources are returned regardless of whether they have tag keys or values associated with them.
", "DisableLogging": "Stops logging information, such as queries and connection attempts, for the specified Amazon Redshift cluster.
", @@ -2122,6 +2122,7 @@ "Cluster$MaintenanceTrackName": "The name of the maintenance track for the cluster.
", "Cluster$ElasticResizeNumberOfNodeOptions": "The number of nodes that you can resize the cluster to with the elastic resize method.
", "Cluster$SnapshotScheduleIdentifier": "A unique identifier for the cluster snapshot schedule.
", + "Cluster$ExpectedNextSnapshotScheduleTimeStatus": "The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:
OnTrack - The next snapshot is expected to be taken on time.
Pending - The next snapshot is pending to be taken.
A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC. If the DbGroups parameter is specifed, DbUser is added to the listed groups for any sessions created using these credentials.
The unique identifier of the cluster.
", @@ -2407,7 +2408,7 @@ "ResetClusterParameterGroupMessage$ParameterGroupName": "The name of the cluster parameter group to be reset.
", "ResizeClusterMessage$ClusterIdentifier": "The unique identifier for the cluster to resize.
", "ResizeClusterMessage$ClusterType": "The new cluster type for the specified cluster.
", - "ResizeClusterMessage$NodeType": "The new node type for the nodes you are adding.
", + "ResizeClusterMessage$NodeType": "The new node type for the nodes you are adding. If not specified, the cluster's current node type is used.
", "ResizeInfo$ResizeType": "Returns the value ClassicResize.
The node type that the cluster will have after the resize operation is complete.
", "ResizeProgressMessage$TargetClusterType": "The cluster type after the resize operation is complete.
Valid Values: multi-node | single-node
The date and time that the cluster was created.
", + "Cluster$ExpectedNextSnapshotScheduleTime": "The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.
", "ClusterCredentials$Expiration": "The date and time the password in DbPassword expires.
The date on which the database revision was released.
", "DeferredMaintenanceWindow$DeferMaintenanceStartTime": "A timestamp for the beginning of the time period when we defer maintenance.
", diff --git a/models/apis/runtime.lex/2016-11-28/api-2.json b/models/apis/runtime.lex/2016-11-28/api-2.json index 5fe565ffa8e..7535ba5b43a 100644 --- a/models/apis/runtime.lex/2016-11-28/api-2.json +++ b/models/apis/runtime.lex/2016-11-28/api-2.json @@ -12,6 +12,37 @@ "uid":"runtime.lex-2016-11-28" }, "operations":{ + "DeleteSession":{ + "name":"DeleteSession", + "http":{ + "method":"DELETE", + "requestUri":"/bot/{botName}/alias/{botAlias}/user/{userId}/session" + }, + "input":{"shape":"DeleteSessionRequest"}, + "output":{"shape":"DeleteSessionResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"ConflictException"} + ] + }, + "GetSession":{ + "name":"GetSession", + "http":{ + "method":"GET", + "requestUri":"/bot/{botName}/alias/{botAlias}/user/{userId}/session" + }, + "input":{"shape":"GetSessionRequest"}, + "output":{"shape":"GetSessionResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"} + ] + }, "PostContent":{ "name":"PostContent", "http":{ @@ -53,6 +84,25 @@ {"shape":"BadGatewayException"}, {"shape":"LoopDetectedException"} ] + }, + "PutSession":{ + "name":"PutSession", + "http":{ + "method":"POST", + "requestUri":"/bot/{botName}/alias/{botAlias}/user/{userId}/session" + }, + "input":{"shape":"PutSessionRequest"}, + "output":{"shape":"PutSessionResponse"}, + "errors":[ + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"}, + {"shape":"ConflictException"}, + {"shape":"NotAcceptableException"}, + {"shape":"DependencyFailedException"}, + {"shape":"BadGatewayException"} + ] } }, "shapes":{ @@ -104,6 +154,14 @@ "max":1000, "min":1 }, + "ConfirmationStatus":{ + "type":"string", + "enum":[ + "None", + "Confirmed", + "Denied" + ] + }, "ConflictException":{ "type":"structure", "members":{ @@ -116,6 +174,40 @@ "type":"string", "enum":["application/vnd.amazonaws.card.generic"] }, + "DeleteSessionRequest":{ + "type":"structure", + "required":[ + "botName", + "botAlias", + "userId" + ], + "members":{ + "botName":{ + "shape":"BotName", + "location":"uri", + "locationName":"botName" + }, + "botAlias":{ + "shape":"BotAlias", + "location":"uri", + "locationName":"botAlias" + }, + "userId":{ + "shape":"UserId", + "location":"uri", + "locationName":"userId" + } + } + }, + "DeleteSessionResponse":{ + "type":"structure", + "members":{ + "botName":{"shape":"BotName"}, + "botAlias":{"shape":"BotAlias"}, + "userId":{"shape":"UserId"}, + "sessionId":{"shape":"String"} + } + }, "DependencyFailedException":{ "type":"structure", "members":{ @@ -124,6 +216,29 @@ "error":{"httpStatusCode":424}, "exception":true }, + "DialogAction":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{"shape":"DialogActionType"}, + "intentName":{"shape":"IntentName"}, + "slots":{"shape":"StringMap"}, + "slotToElicit":{"shape":"String"}, + "fulfillmentState":{"shape":"FulfillmentState"}, + "message":{"shape":"Text"}, + "messageFormat":{"shape":"MessageFormatType"} + } + }, + "DialogActionType":{ + "type":"string", + "enum":[ + "ElicitIntent", + "ConfirmIntent", + "ElicitSlot", + "Close", + "Delegate" + ] + }, "DialogState":{ "type":"string", "enum":[ @@ -136,6 +251,14 @@ ] }, "ErrorMessage":{"type":"string"}, + "FulfillmentState":{ + "type":"string", + "enum":[ + "Fulfilled", + "Failed", + "ReadyForFulfillment" + ] + }, "GenericAttachment":{ "type":"structure", "members":{ @@ -146,8 +269,60 @@ "buttons":{"shape":"listOfButtons"} } }, + "GetSessionRequest":{ + "type":"structure", + "required":[ + "botName", + "botAlias", + "userId" + ], + "members":{ + "botName":{ + "shape":"BotName", + "location":"uri", + "locationName":"botName" + }, + "botAlias":{ + "shape":"BotAlias", + "location":"uri", + "locationName":"botAlias" + }, + "userId":{ + "shape":"UserId", + "location":"uri", + "locationName":"userId" + } + } + }, + "GetSessionResponse":{ + "type":"structure", + "members":{ + "recentIntentSummaryView":{"shape":"IntentSummaryList"}, + "sessionAttributes":{"shape":"StringMap"}, + "sessionId":{"shape":"String"}, + "dialogAction":{"shape":"DialogAction"} + } + }, "HttpContentType":{"type":"string"}, "IntentName":{"type":"string"}, + "IntentSummary":{ + "type":"structure", + "required":["dialogActionType"], + "members":{ + "intentName":{"shape":"IntentName"}, + "slots":{"shape":"StringMap"}, + "confirmationStatus":{"shape":"ConfirmationStatus"}, + "dialogActionType":{"shape":"DialogActionType"}, + "fulfillmentState":{"shape":"FulfillmentState"}, + "slotToElicit":{"shape":"String"} + } + }, + "IntentSummaryList":{ + "type":"list", + "member":{"shape":"IntentSummary"}, + "max":3, + "min":0 + }, "InternalFailureException":{ "type":"structure", "members":{ @@ -350,6 +525,92 @@ "responseCard":{"shape":"ResponseCard"} } }, + "PutSessionRequest":{ + "type":"structure", + "required":[ + "botName", + "botAlias", + "userId" + ], + "members":{ + "botName":{ + "shape":"BotName", + "location":"uri", + "locationName":"botName" + }, + "botAlias":{ + "shape":"BotAlias", + "location":"uri", + "locationName":"botAlias" + }, + "userId":{ + "shape":"UserId", + "location":"uri", + "locationName":"userId" + }, + "sessionAttributes":{"shape":"StringMap"}, + "dialogAction":{"shape":"DialogAction"}, + "accept":{ + "shape":"Accept", + "location":"header", + "locationName":"Accept" + } + } + }, + "PutSessionResponse":{ + "type":"structure", + "members":{ + "contentType":{ + "shape":"HttpContentType", + "location":"header", + "locationName":"Content-Type" + }, + "intentName":{ + "shape":"IntentName", + "location":"header", + "locationName":"x-amz-lex-intent-name" + }, + "slots":{ + "shape":"String", + "jsonvalue":true, + "location":"header", + "locationName":"x-amz-lex-slots" + }, + "sessionAttributes":{ + "shape":"String", + "jsonvalue":true, + "location":"header", + "locationName":"x-amz-lex-session-attributes" + }, + "message":{ + "shape":"Text", + "location":"header", + "locationName":"x-amz-lex-message" + }, + "messageFormat":{ + "shape":"MessageFormatType", + "location":"header", + "locationName":"x-amz-lex-message-format" + }, + "dialogState":{ + "shape":"DialogState", + "location":"header", + "locationName":"x-amz-lex-dialog-state" + }, + "slotToElicit":{ + "shape":"String", + "location":"header", + "locationName":"x-amz-lex-slot-to-elicit" + }, + "audioStream":{"shape":"BlobStream"}, + "sessionId":{ + "shape":"String", + "location":"header", + "locationName":"x-amz-lex-session-id" + } + }, + "payload":"audioStream" + }, "RequestTimeoutException":{ "type":"structure", "members":{ diff --git a/models/apis/runtime.lex/2016-11-28/docs-2.json b/models/apis/runtime.lex/2016-11-28/docs-2.json index 322e5e8dae9..03b303df9b2 100644 --- a/models/apis/runtime.lex/2016-11-28/docs-2.json +++ b/models/apis/runtime.lex/2016-11-28/docs-2.json @@ -2,21 +2,25 @@ "version": "2.0", "service": "Amazon Lex provides both build and runtime endpoints. Each endpoint provides a set of operations (API). Your conversational bot uses the runtime API to understand user utterances (user input text or voice). For example, suppose a user says \"I want pizza\", your bot sends this input to Amazon Lex using the runtime API. Amazon Lex recognizes that the user request is for the OrderPizza intent (one of the intents defined in the bot). Then Amazon Lex engages in user conversation on behalf of the bot to elicit required information (slot values, such as pizza size and crust type), and then performs fulfillment activity (that you configured when you created the bot). You use the build-time API to create and manage your Amazon Lex bot. For a list of build-time operations, see the build-time API, .
", "operations": { - "PostContent": "Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot.
The PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications.
In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:
For a user input \"I would like a pizza,\" Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): \"What size pizza would you like?\".
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: \"Order the pizza?\".
After the user replies \"Yes\" to the confirmation prompt, Amazon Lex might return a conclusion statement: \"Thank you, your cheese pizza has been ordered.\".
Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the message, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information:
x-amz-lex-dialog-state header set to ElicitSlot
x-amz-lex-intent-name header set to the intent name in the current context
x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting information
x-amz-lex-slots header set to a map of slots configured for the intent with their current values
If the message is a confirmation prompt, the x-amz-lex-dialog-state header is set to Confirmation and the x-amz-lex-slot-to-elicit header is omitted.
If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the x-amz-dialog-state header is set to ElicitIntent and the x-amz-slot-to-elicit header is omitted.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context.
Sends user input (text-only) to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot.
In response, Amazon Lex returns the next message to convey to the user an optional responseCard to display. Consider the following example messages:
For a user input \"I would like a pizza\", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): \"What size pizza would you like?\"
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation \"Proceed with the pizza order?\".
After the user replies to a confirmation prompt with a \"yes\", Amazon Lex might return a conclusion statement: \"Thank you, your cheese pizza has been ordered.\".
Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a \"yes\" or \"no\" user response. In addition to the message, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the slotToElicit, dialogState, intentName, and slots fields in the response. Consider the following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information:
dialogState set to ElicitSlot
intentName set to the intent name in the current context
slotToElicit set to the slot name for which the message is eliciting information
slots set to a map of slots, configured for the intent, with currently known values
If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and SlotToElicit is set to null.
If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the dialogState is set to ElicitIntent and slotToElicit is set to null.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context.
Removes session information for a specified bot, alias, and user ID.
", + "GetSession": "Returns session information for a specified bot, alias, and user ID.
", + "PostContent": "Sends user input (text or speech) to Amazon Lex. Clients use this API to send text and audio requests to Amazon Lex at runtime. Amazon Lex interprets the user input using the machine learning model that it built for the bot.
The PostContent operation supports audio input at 8kHz and 16kHz. You can use 8kHz audio to achieve higher speech recognition accuracy in telephone audio applications.
In response, Amazon Lex returns the next message to convey to the user. Consider the following example messages:
For a user input \"I would like a pizza,\" Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): \"What size pizza would you like?\".
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to get user confirmation: \"Order the pizza?\".
After the user replies \"Yes\" to the confirmation prompt, Amazon Lex might return a conclusion statement: \"Thank you, your cheese pizza has been ordered.\".
Not all Amazon Lex messages require a response from the user. For example, conclusion statements do not require a response. Some messages require only a yes or no response. In addition to the message, Amazon Lex provides additional context about the message in the response that you can use to enhance client behavior, such as displaying the appropriate client user interface. Consider the following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information:
x-amz-lex-dialog-state header set to ElicitSlot
x-amz-lex-intent-name header set to the intent name in the current context
x-amz-lex-slot-to-elicit header set to the slot name for which the message is eliciting information
x-amz-lex-slots header set to a map of slots configured for the intent with their current values
If the message is a confirmation prompt, the x-amz-lex-dialog-state header is set to Confirmation and the x-amz-lex-slot-to-elicit header is omitted.
If the message is a clarification prompt configured for the intent, indicating that the user intent is not understood, the x-amz-dialog-state header is set to ElicitIntent and the x-amz-slot-to-elicit header is omitted.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context.
Sends user input (text or SSML) to Amazon Lex. Client applications can use this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets the user input using the machine learning model it built for the bot.
In response, Amazon Lex returns the next message to convey to the user an optional responseCard to display. Consider the following example messages:
For a user input \"I would like a pizza\", Amazon Lex might return a response with a message eliciting slot data (for example, PizzaSize): \"What size pizza would you like?\"
After the user provides all of the pizza order information, Amazon Lex might return a response with a message to obtain user confirmation \"Proceed with the pizza order?\".
After the user replies to a confirmation prompt with a \"yes\", Amazon Lex might return a conclusion statement: \"Thank you, your cheese pizza has been ordered.\".
Not all Amazon Lex messages require a user response. For example, a conclusion statement does not require a response. Some messages require only a \"yes\" or \"no\" user response. In addition to the message, Amazon Lex provides additional context about the message in the response that you might use to enhance client behavior, for example, to display the appropriate client user interface. These are the slotToElicit, dialogState, intentName, and slots fields in the response. Consider the following examples:
If the message is to elicit slot data, Amazon Lex returns the following context information:
dialogState set to ElicitSlot
intentName set to the intent name in the current context
slotToElicit set to the slot name for which the message is eliciting information
slots set to a map of slots, configured for the intent, with currently known values
If the message is a confirmation prompt, the dialogState is set to ConfirmIntent and SlotToElicit is set to null.
If the message is a clarification prompt (configured for the intent) that indicates that user intent is not understood, the dialogState is set to ElicitIntent and slotToElicit is set to null.
In addition, Amazon Lex also returns your application-specific sessionAttributes. For more information, see Managing Conversation Context.
Creates a new session or modifies an existing session with an Amazon Lex bot. Use this operation to enable your application to set the state of the bot.
For more information, see Managing Sessions.
" }, "shapes": { "Accept": { "base": null, "refs": { - "PostContentRequest$accept": " You pass this value as the Accept HTTP header.
The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.
If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.
If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the Accept header). For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm
text/plain; charset=utf-8
audio/* (defaults to mpeg)
You pass this value as the Accept HTTP header.
The message Amazon Lex returns in the response can be either text or speech based on the Accept HTTP header value in the request.
If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.
If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech (using the configuration you specified in the Accept header). For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.
If the value is audio/pcm, the speech returned is audio/pcm in 16-bit, little endian format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm
text/plain; charset=utf-8
audio/* (defaults to mpeg)
The message that Amazon Lex returns in the response can be either text or speech based depending on the value of this field.
If the value is text/plain; charset=utf-8, Amazon Lex returns text in the response.
If the value begins with audio/, Amazon Lex returns speech in the response. Amazon Lex uses Amazon Polly to generate the speech in the configuration that you specify. For example, if you specify audio/mpeg as the value, Amazon Lex returns speech in the MPEG format.
If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, little endian format.
The following are the accepted values:
audio/mpeg
audio/ogg
audio/pcm
audio/* (defaults to mpeg)
text/plain; charset=utf-8
You pass this value as the x-amz-lex-session-attributes HTTP header.
Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.
For more information, see Setting Session Attributes.
", - "PostContentRequest$requestAttributes": "You pass this value as the x-amz-lex-request-attributes HTTP header.
Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.
The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.
For more information, see Setting Request Attributes.
" + "PostContentRequest$sessionAttributes": "You pass this value as the x-amz-lex-session-attributes HTTP header.
Application-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the sessionAttributes and requestAttributes headers is limited to 12 KB.
For more information, see Setting Session Attributes.
", + "PostContentRequest$requestAttributes": "You pass this value as the x-amz-lex-request-attributes HTTP header.
Request-specific information passed between Amazon Lex and a client application. The value must be a JSON serialized and base64 encoded map with string keys and values. The total size of the requestAttributes and sessionAttributes headers is limited to 12 KB.
The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.
For more information, see Setting Request Attributes.
" } }, "BadGatewayException": { @@ -33,21 +37,30 @@ "base": null, "refs": { "PostContentRequest$inputStream": " User input in PCM or Opus audio format or text format as described in the Content-Type HTTP header.
You can stream audio data to Amazon Lex or you can create a local buffer that captures all of the audio data before sending. In general, you get better performance if you stream audio data rather than buffering the data locally.
", - "PostContentResponse$audioStream": "The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the response.
The prompt (or statement) to convey to the user. This is based on the bot configuration and context. For example, if Amazon Lex did not understand the user intent, it sends the clarificationPrompt configured for the bot. If the intent requires confirmation before taking the fulfillment action, it sends the confirmationPrompt. Another example: Suppose that the Lambda function successfully fulfilled the intent, and sent a message to convey to the user. Then Amazon Lex sends that message in the response.
The audio version of the message to convey to the user.
" } }, "BotAlias": { "base": null, "refs": { + "DeleteSessionRequest$botAlias": "The alias in use for the bot that contains the session data.
", + "DeleteSessionResponse$botAlias": "The alias in use for the bot associated with the session data.
", + "GetSessionRequest$botAlias": "The alias in use for the bot that contains the session data.
", "PostContentRequest$botAlias": "Alias of the Amazon Lex bot.
", - "PostTextRequest$botAlias": "The alias of the Amazon Lex bot.
" + "PostTextRequest$botAlias": "The alias of the Amazon Lex bot.
", + "PutSessionRequest$botAlias": "The alias in use for the bot that contains the session data.
" } }, "BotName": { "base": null, "refs": { + "DeleteSessionRequest$botName": "The name of the bot that contains the session data.
", + "DeleteSessionResponse$botName": "The name of the bot associated with the session data.
", + "GetSessionRequest$botName": "The name of the bot that contains the session data.
", "PostContentRequest$botName": "Name of the Amazon Lex bot.
", - "PostTextRequest$botName": "The name of the Amazon Lex bot.
" + "PostTextRequest$botName": "The name of the Amazon Lex bot.
", + "PutSessionRequest$botName": "The name of the bot that contains the session data.
" } }, "Button": { @@ -68,6 +81,12 @@ "Button$value": "The value sent to Amazon Lex when a user chooses the button. For example, consider button text \"NYC.\" When the user chooses the button, the value sent can be \"New York City.\"
" } }, + "ConfirmationStatus": { + "base": null, + "refs": { + "IntentSummary$confirmationStatus": "The status of the intent after the user responds to the confirmation prompt. If the user confirms the intent, Amazon Lex sets this field to Confirmed. If the user denies the intent, Amazon Lex sets this value to Denied. The possible values are:
Confirmed - The user has responded \"Yes\" to the confirmation prompt, confirming that the intent is complete and that it is ready to be fulfilled.
Denied - The user has responded \"No\" to the confirmation prompt.
None - The user has never been prompted for confirmation; or, the user was prompted but did not confirm or deny the prompt.
Two clients are using the same AWS account, Amazon Lex bot, and user ID.
", "refs": { @@ -79,16 +98,41 @@ "ResponseCard$contentType": "The content type of the response.
" } }, + "DeleteSessionRequest": { + "base": null, + "refs": { + } + }, + "DeleteSessionResponse": { + "base": null, + "refs": { + } + }, "DependencyFailedException": { "base": "One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. For example,
If Amazon Lex does not have sufficient permissions to call a Lambda function.
If a Lambda function takes longer than 30 seconds to execute.
If a fulfillment Lambda function returns a Delegate dialog action without removing any slot values.
Describes the next action that the bot should take in its interaction with the user and provides information about the context in which the action takes place. Use the DialogAction data type to set the interaction to a specific state, or to return the interaction to a previous state.
Describes the current state of the bot.
", + "PutSessionRequest$dialogAction": "Sets the next action that the bot should take to fulfill the conversation.
" + } + }, + "DialogActionType": { + "base": null, + "refs": { + "DialogAction$type": "The next action that the bot should take in its interaction with the user. The possible values are:
ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as \"Place the order?\"
Close - Indicates that the there will not be a response from the user. For example, the statement \"Your order has been placed\" does not require a response.
Delegate - The next action is determined by Amazon Lex.
ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
ElicitSlot - The next action is to elicit a slot value from the user.
The next action that the bot should take in its interaction with the user. The possible values are:
ConfirmIntent - The next action is asking the user if the intent is complete and ready to be fulfilled. This is a yes/no question such as \"Place the order?\"
Close - Indicates that the there will not be a response from the user. For example, the statement \"Your order has been placed\" does not require a response.
ElicitIntent - The next action is to determine the intent that the user wants to fulfill.
ElicitSlot - The next action is to elicit a slot value from the user.
Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
ElicitIntent - Amazon Lex wants to elicit the user's intent. Consider the following examples:
For example, a user might utter an intent (\"I want to order a pizza\"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state.
ConfirmIntent - Amazon Lex is expecting a \"yes\" or \"no\" response.
For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple \"yes\" or \"no\" response, a user might respond with additional information. For example, \"yes, but make it a thick crust pizza\" or \"no, I want to order a drink.\" Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink).
ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
For example, suppose that in the response Amazon Lex sends this message: \"What size pizza would you like?\". A user might reply with the slot value (e.g., \"medium\"). The user might also provide additional information in the response (e.g., \"medium thick crust pizza\"). Amazon Lex can process such additional information appropriately.
Fulfilled - Conveys that the Lambda function has successfully fulfilled the intent.
ReadyForFulfillment - Conveys that the client has to fulfill the request.
Failed - Conveys that the conversation with the user failed.
This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent.
Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
ElicitIntent - Amazon Lex wants to elicit user intent.
For example, a user might utter an intent (\"I want to order a pizza\"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
ConfirmIntent - Amazon Lex is expecting a \"yes\" or \"no\" response.
For example, Amazon Lex wants user confirmation before fulfilling an intent.
Instead of a simple \"yes\" or \"no,\" a user might respond with additional information. For example, \"yes, but make it thick crust pizza\" or \"no, I want to order a drink\". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
For example, suppose that in the response Amazon Lex sends this message: \"What size pizza would you like?\". A user might reply with the slot value (e.g., \"medium\"). The user might also provide additional information in the response (e.g., \"medium thick crust pizza\"). Amazon Lex can process such additional information appropriately.
Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.
ReadyForFulfillment - Conveys that the client has to fulfill the intent.
Failed - Conveys that the conversation with the user failed.
This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.
Identifies the current state of the user interaction. Amazon Lex returns one of the following values as dialogState. The client can optionally use this information to customize the user interface.
ElicitIntent - Amazon Lex wants to elicit user intent.
For example, a user might utter an intent (\"I want to order a pizza\"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialogState.
ConfirmIntent - Amazon Lex is expecting a \"yes\" or \"no\" response.
For example, Amazon Lex wants user confirmation before fulfilling an intent.
Instead of a simple \"yes\" or \"no,\" a user might respond with additional information. For example, \"yes, but make it thick crust pizza\" or \"no, I want to order a drink\". Amazon Lex can process such additional information (in these examples, update the crust type slot value, or change intent from OrderPizza to OrderDrink).
ElicitSlot - Amazon Lex is expecting a slot value for the current intent.
For example, suppose that in the response Amazon Lex sends this message: \"What size pizza would you like?\". A user might reply with the slot value (e.g., \"medium\"). The user might also provide additional information in the response (e.g., \"medium thick crust pizza\"). Amazon Lex can process such additional information appropriately.
Fulfilled - Conveys that the Lambda function configured for the intent has successfully fulfilled the intent.
ReadyForFulfillment - Conveys that the client has to fulfill the intent.
Failed - Conveys that the conversation with the user failed.
This can happen for various reasons including that the user did not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or the Lambda function failed to fulfill the intent.
ConfirmIntent - Amazon Lex is expecting a \"yes\" or \"no\" response to confirm the intent before fulfilling an intent.
ElicitIntent - Amazon Lex wants to elicit the user's intent.
ElicitSlot - Amazon Lex is expecting the value of a slot for the current intent.
Failed - Conveys that the conversation with the user has failed. This can happen for various reasons, including the user does not provide an appropriate response to prompts from the service, or if the Lambda function fails to fulfill the intent.
Fulfilled - Conveys that the Lambda function has sucessfully fulfilled the intent.
ReadyForFulfillment - Conveys that the client has to fulfill the intent.
The fulfillment state of the intent. The possible values are:
Failed - The Lambda function associated with the intent failed to fulfill the intent.
Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
The fulfillment state of the intent. The possible values are:
Failed - The Lambda function associated with the intent failed to fulfill the intent.
Fulfilled - The intent has fulfilled by the Lambda function associated with the intent.
ReadyForFulfillment - All of the information necessary for the intent is present and the intent ready to be fulfilled by the client application.
Represents an option rendered to the user when a prompt is shown. It could be an image, a button, a link, or text.
", "refs": { "genericAttachmentList$member": null } }, + "GetSessionRequest": { + "base": null, + "refs": { + } + }, + "GetSessionResponse": { + "base": null, + "refs": { + } + }, "HttpContentType": { "base": null, "refs": { "PostContentRequest$contentType": " You pass this value as the Content-Type HTTP header.
Indicates the audio format or text. The header value must start with one of the following prefixes:
PCM format, audio data must be in little-endian byte order.
audio/l16; rate=16000; channels=1
audio/x-l16; sample-rate=16000; channel-count=1
audio/lpcm; sample-rate=8000; sample-size-bits=16; channel-count=1; is-big-endian=false
Opus format
audio/x-cbr-opus-with-preamble; preamble-size=0; bit-rate=256000; frame-size-milliseconds=4
Text format
text/plain; charset=utf-8
Content type as specified in the Accept HTTP header in the request.
Content type as specified in the Accept HTTP header in the request.
Content type as specified in the Accept HTTP header in the request.
The name of the intent.
", + "IntentSummary$intentName": "The name of the intent.
", "PostContentResponse$intentName": "Current user intent that Amazon Lex is aware of.
", - "PostTextResponse$intentName": "The current user intent that Amazon Lex is aware of.
" + "PostTextResponse$intentName": "The current user intent that Amazon Lex is aware of.
", + "PutSessionResponse$intentName": "The name of the current intent.
" + } + }, + "IntentSummary": { + "base": "Provides information about the state of an intent. You can use this information to get the current state of an intent so that you can process the intent, or so that you can return the intent to its previous state.
", + "refs": { + "IntentSummaryList$member": null + } + }, + "IntentSummaryList": { + "base": null, + "refs": { + "GetSessionResponse$recentIntentSummaryView": "An array of information about the intents used in the session. The array can contain a maximum of three summaries. If more than three intents are used in the session, the recentIntentSummaryView operation contains information about the last three intents used.
PlainText - The message contains plain UTF-8 text.
CustomPayload - The message is a custom format for the client.
SSML - The message contains text formatted for voice output.
Composite - The message contains an escaped JSON object containing one or more messages. For more information, see Message Groups.
The format of the response message. One of the following values:
PlainText - The message contains plain UTF-8 text.
CustomPayload - The message is a custom format for the client.
SSML - The message contains text formatted for voice output.
Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.
The format of the response message. One of the following values:
PlainText - The message contains plain UTF-8 text.
CustomPayload - The message is a custom format defined by the Lambda function.
SSML - The message contains text formatted for voice output.
Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.
The format of the response message. One of the following values:
PlainText - The message contains plain UTF-8 text.
CustomPayload - The message is a custom format defined by the Lambda function.
SSML - The message contains text formatted for voice output.
Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.
The format of the response message. One of the following values:
PlainText - The message contains plain UTF-8 text.
CustomPayload - The message is a custom format for the client.
SSML - The message contains text formatted for voice output.
Composite - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.
The input speech is too long.
", "refs": { @@ -187,16 +276,24 @@ "refs": { "BadRequestException$message": null, "ConflictException$message": null, + "DeleteSessionResponse$sessionId": "The unique identifier for the session.
", + "DialogAction$slotToElicit": "The name of the slot that should be elicited from the user.
", + "GetSessionResponse$sessionId": "A unique identifier for the session.
", + "IntentSummary$slotToElicit": "The next slot to elicit from the user. If there is not slot to elicit, the field is blank.
", "InternalFailureException$message": null, "LimitExceededException$retryAfterSeconds": null, "LimitExceededException$message": null, "NotAcceptableException$message": null, "NotFoundException$message": null, - "PostContentResponse$slots": "Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation.
Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.
Map of zero or more intent slots (name/value pairs) Amazon Lex detected from the user input during the conversation. The field is base-64 encoded.
Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.
Map of key/value pairs representing the session-specific context information.
", "PostContentResponse$slotToElicit": " If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
The text used to process the request.
If the input was an audio stream, the inputTranscript field contains the text extracted from the audio stream. This is the text that is actually processed to recognize intents and slot values. You can use this information to determine if Amazon Lex is correctly processing the audio that you send.
If the dialogState value is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
Map of zero or more intent slots Amazon Lex detected from the user input during the conversation.
Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy the default is ORIGINAL_VALUE.
Map of key/value pairs representing session-specific context information.
", + "PutSessionResponse$slotToElicit": "If the dialogState is ElicitSlot, returns the name of the slot for which Amazon Lex is eliciting a value.
A unique identifier for the session.
", "RequestTimeoutException$message": null, "ResponseCard$version": "The version of the response card format.
", "StringMap$key": null, @@ -207,10 +304,14 @@ "StringMap": { "base": null, "refs": { - "PostTextRequest$sessionAttributes": "Application-specific information passed between Amazon Lex and a client application.
For more information, see Setting Session Attributes.
", - "PostTextRequest$requestAttributes": "Request-specific information passed between Amazon Lex and a client application.
The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.
For more information, see Setting Request Attributes.
", + "DialogAction$slots": "Map of the slots that have been gathered and their values.
", + "GetSessionResponse$sessionAttributes": "Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.
", + "IntentSummary$slots": "Map of the slots that have been gathered and their values.
", + "PostTextRequest$sessionAttributes": "Application-specific information passed between Amazon Lex and a client application.
For more information, see Setting Session Attributes.
", + "PostTextRequest$requestAttributes": "Request-specific information passed between Amazon Lex and a client application.
The namespace x-amz-lex: is reserved for special attributes. Don't create any request attributes with the prefix x-amz-lex:.
For more information, see Setting Request Attributes.
", "PostTextResponse$slots": "The intent slots that Amazon Lex detected from the user input in the conversation.
Amazon Lex creates a resolution list containing likely values for a slot. The value that it returns is determined by the valueSelectionStrategy selected when the slot type was created or updated. If valueSelectionStrategy is set to ORIGINAL_VALUE, the value provided by the user is returned, if the user value is similar to the slot values. If valueSelectionStrategy is set to TOP_RESOLUTION Amazon Lex returns the first value in the resolution list or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy, the default is ORIGINAL_VALUE.
A map of key-value pairs representing the session-specific context information.
" + "PostTextResponse$sessionAttributes": "A map of key-value pairs representing the session-specific context information.
", + "PutSessionRequest$sessionAttributes": "Map of key/value pairs representing the session-specific context information. It contains application information passed between Amazon Lex and a client application.
" } }, "StringUrlWithLength": { @@ -230,9 +331,11 @@ "Text": { "base": null, "refs": { - "PostContentResponse$message": "The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
", + "DialogAction$message": "The message that should be shown to the user. If you don't specify a message, Amazon Lex will use the message configured for the intent.
", + "PostContentResponse$message": "The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type in its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
", "PostTextRequest$inputText": "The text that the user entered (Amazon Lex interprets this text).
", - "PostTextResponse$message": "The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
" + "PostTextResponse$message": "The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.
If the intent is not configured with a Lambda function, or if the Lambda function returned Delegate as the dialogAction.type its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.
When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see msg-prompts-formats.
If the Lambda function returns a message, Amazon Lex passes it to the client in its response.
", + "PutSessionResponse$message": "The next message that should be presented to the user.
" } }, "UnsupportedMediaTypeException": { @@ -243,8 +346,12 @@ "UserId": { "base": null, "refs": { + "DeleteSessionRequest$userId": "The identifier of the user associated with the session data.
", + "DeleteSessionResponse$userId": "The ID of the client application user.
", + "GetSessionRequest$userId": "The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.
", "PostContentRequest$userId": "The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.
To decide the user ID to use for your application, consider the following factors.
The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.
To decide the user ID to use for your application, consider the following factors.
The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot. At runtime, each request must contain the userID field.
To decide the user ID to use for your application, consider the following factors.
The userID field must not contain any personally identifiable information of the user, for example, name, personal identification numbers, or other end user personal information.
If you want a user to start a conversation on one device and continue on another device, use a user-specific identifier.
If you want the same user to be able to have two independent conversations on two different devices, choose a device-specific identifier.
A user can't have two independent conversations with two different versions of the same bot. For example, a user can't have a conversation with the PROD and BETA versions of the same bot. If you anticipate that a user will need to have conversation with two different versions, for example, while testing, include the bot alias in the user ID to separate the two conversations.
The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.
" } }, "genericAttachmentList": { diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 61132926d09..748c80c8522 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -1438,6 +1438,7 @@ }, "hostname" : "es-fips.us-west-1.amazonaws.com" }, + "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -1871,6 +1872,15 @@ "us-west-2" : { } } }, + "lakeformation" : { + "endpoints" : { + "ap-northeast-1" : { }, + "eu-west-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-2" : { } + } + }, "lambda" : { "endpoints" : { "ap-east-1" : { }, @@ -4339,6 +4349,18 @@ "us-gov-west-1" : { } } }, + "route53" : { + "endpoints" : { + "aws-us-gov-global" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "route53.us-gov.amazonaws.com" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-us-gov-global" + }, "runtime.sagemaker" : { "endpoints" : { "us-gov-west-1" : { } diff --git a/service/guardduty/api.go b/service/guardduty/api.go index 5f373927956..a7d9696869b 100644 --- a/service/guardduty/api.go +++ b/service/guardduty/api.go @@ -140,7 +140,10 @@ func (c *GuardDuty) ArchiveFindingsRequest(input *ArchiveFindingsInput) (req *re // ArchiveFindings API operation for Amazon GuardDuty. // -// Archives Amazon GuardDuty findings specified by the list of finding IDs. +// Archives GuardDuty findings specified by the list of finding IDs. +// +// Only the master account can archive findings. Member accounts do not have +// permission to archive findings from their accounts. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -222,9 +225,10 @@ func (c *GuardDuty) CreateDetectorRequest(input *CreateDetectorInput) (req *requ // CreateDetector API operation for Amazon GuardDuty. // -// Creates a single Amazon GuardDuty detector. A detector is an object that -// represents the GuardDuty service. A detector must be created in order for -// GuardDuty to become operational. +// Creates a single Amazon GuardDuty detector. A detector is a resource that +// represents the GuardDuty service. To start using GuardDuty, you must create +// a detector in each region that you enable the service. You can have only +// one detector per account per region. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1963,8 +1967,8 @@ func (c *GuardDuty) GetMasterAccountRequest(input *GetMasterAccountInput) (req * // GetMasterAccount API operation for Amazon GuardDuty. // -// Provides the details for the GuardDuty master account to the current GuardDuty -// member account. +// Provides the details for the GuardDuty master account associated with the +// current GuardDuty member account. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -4221,6 +4225,7 @@ func (s AcceptInvitationOutput) GoString() string { return s.String() } +// Contains information about the access keys. type AccessKeyDetails struct { _ struct{} `type:"structure"` @@ -4271,6 +4276,7 @@ func (s *AccessKeyDetails) SetUserType(v string) *AccessKeyDetails { return s } +// Contains information about the account. type AccountDetail struct { _ struct{} `type:"structure"` @@ -4329,6 +4335,7 @@ func (s *AccountDetail) SetEmail(v string) *AccountDetail { return s } +// Contains information about action. type Action struct { _ struct{} `type:"structure"` @@ -4458,6 +4465,7 @@ func (s ArchiveFindingsOutput) GoString() string { return s.String() } +// Contains information about the API operation. type AwsApiCallAction struct { _ struct{} `type:"structure"` @@ -4517,6 +4525,7 @@ func (s *AwsApiCallAction) SetServiceName(v string) *AwsApiCallAction { return s } +// Contains information about the city associated with the IP address. type City struct { _ struct{} `type:"structure"` @@ -4540,15 +4549,18 @@ func (s *City) SetCityName(v string) *City { return s } +// Contains information about the condition. type Condition struct { _ struct{} `type:"structure"` - // Represents the equal condition to be applied to a single field when querying - // for findings. + // Deprecated. Represents the equal condition to be applied to a single field + // when querying for findings. // // Deprecated: Eq has been deprecated Eq []*string `locationName:"eq" deprecated:"true" type:"list"` + // Represents an equal condition to be applied to a single field when querying + // for findings. Equals []*string `locationName:"equals" type:"list"` // Represents a greater than condition to be applied to a single field when @@ -4559,14 +4571,14 @@ type Condition struct { // when querying for findings. GreaterThanOrEqual *int64 `locationName:"greaterThanOrEqual" type:"long"` - // Represents a greater than condition to be applied to a single field when - // querying for findings. + // Deprecated. Represents a greater than condition to be applied to a single + // field when querying for findings. // // Deprecated: Gt has been deprecated Gt *int64 `locationName:"gt" deprecated:"true" type:"integer"` - // Represents a greater than equal condition to be applied to a single field - // when querying for findings. + // Deprecated. Represents a greater than equal condition to be applied to a + // single field when querying for findings. // // Deprecated: Gte has been deprecated Gte *int64 `locationName:"gte" deprecated:"true" type:"integer"` @@ -4579,24 +4591,26 @@ type Condition struct { // querying for findings. LessThanOrEqual *int64 `locationName:"lessThanOrEqual" type:"long"` - // Represents a less than condition to be applied to a single field when querying - // for findings. + // Deprecated. Represents a less than condition to be applied to a single field + // when querying for findings. // // Deprecated: Lt has been deprecated Lt *int64 `locationName:"lt" deprecated:"true" type:"integer"` - // Represents a less than equal condition to be applied to a single field when - // querying for findings. + // Deprecated. Represents a less than equal condition to be applied to a single + // field when querying for findings. // // Deprecated: Lte has been deprecated Lte *int64 `locationName:"lte" deprecated:"true" type:"integer"` - // Represents the not equal condition to be applied to a single field when querying - // for findings. + // Deprecated. Represents the not equal condition to be applied to a single + // field when querying for findings. // // Deprecated: Neq has been deprecated Neq []*string `locationName:"neq" deprecated:"true" type:"list"` + // Represents an not equal condition to be applied to a single field when querying + // for findings. NotEquals []*string `locationName:"notEquals" type:"list"` } @@ -4682,6 +4696,7 @@ func (s *Condition) SetNotEquals(v []*string) *Condition { return s } +// Contains information about the country. type Country struct { _ struct{} `type:"structure"` @@ -5827,8 +5842,7 @@ func (s *DeleteMembersInput) SetDetectorId(v string) *DeleteMembersInput { type DeleteMembersOutput struct { _ struct{} `type:"structure"` - // A list of objects containing the unprocessed account and a result string - // explaining why it was unprocessed. + // The accounts that could not be processed. // // UnprocessedAccounts is a required field UnprocessedAccounts []*UnprocessedAccount `locationName:"unprocessedAccounts" type:"list" required:"true"` @@ -6063,6 +6077,7 @@ func (s *DisassociateMembersOutput) SetUnprocessedAccounts(v []*UnprocessedAccou return s } +// Contains information about the DNS request. type DnsRequestAction struct { _ struct{} `type:"structure"` @@ -6086,6 +6101,7 @@ func (s *DnsRequestAction) SetDomain(v string) *DnsRequestAction { return s } +// Contains information about the domain. type DomainDetails struct { _ struct{} `type:"structure"` @@ -6109,73 +6125,95 @@ func (s *DomainDetails) SetDomain(v string) *DomainDetails { return s } +// Contains information about the reason that the finding was generated. +type Evidence struct { + _ struct{} `type:"structure"` + + // A list of threat intelligence details related to the evidence. + ThreatIntelligenceDetails []*ThreatIntelligenceDetail `locationName:"threatIntelligenceDetails" type:"list"` +} + +// String returns the string representation +func (s Evidence) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s Evidence) GoString() string { + return s.String() +} + +// SetThreatIntelligenceDetails sets the ThreatIntelligenceDetails field's value. +func (s *Evidence) SetThreatIntelligenceDetails(v []*ThreatIntelligenceDetail) *Evidence { + s.ThreatIntelligenceDetails = v + return s +} + +// Contains information about the finding. type Finding struct { _ struct{} `type:"structure"` - // AWS account ID where the activity occurred that prompted GuardDuty to generate - // a finding. + // The ID of the account in which the finding was generated. // // AccountId is a required field AccountId *string `locationName:"accountId" type:"string" required:"true"` - // The ARN of a finding described by the action. + // The ARN for the finding. // // Arn is a required field Arn *string `locationName:"arn" type:"string" required:"true"` - // The confidence level of a finding. + // The confidence score for the finding. Confidence *float64 `locationName:"confidence" type:"double"` - // The time stamp at which a finding was generated. + // The time and date at which the finding was created. // // CreatedAt is a required field CreatedAt *string `locationName:"createdAt" type:"string" required:"true"` - // The description of a finding. + // The description of the finding. Description *string `locationName:"description" type:"string"` - // The identifier that corresponds to a finding described by the action. + // The ID of the finding. // // Id is a required field Id *string `locationName:"id" type:"string" required:"true"` - // The AWS resource partition. + // The partition associated with the finding. Partition *string `locationName:"partition" type:"string"` - // The AWS region where the activity occurred that prompted GuardDuty to generate - // a finding. + // The Region in which the finding was generated. // // Region is a required field Region *string `locationName:"region" type:"string" required:"true"` - // The AWS resource associated with the activity that prompted GuardDuty to - // generate a finding. + // Contains information about the resource. // // Resource is a required field Resource *Resource `locationName:"resource" type:"structure" required:"true"` - // Findings' schema version. + // The version of the schema used for the finding. // // SchemaVersion is a required field SchemaVersion *string `locationName:"schemaVersion" type:"string" required:"true"` - // Additional information assigned to the generated finding by GuardDuty. + // Contains information about the service. Service *Service `locationName:"service" type:"structure"` - // The severity of a finding. + // The severity of the finding. // // Severity is a required field Severity *float64 `locationName:"severity" type:"double" required:"true"` - // The title of a finding. + // The title for the finding. Title *string `locationName:"title" type:"string"` - // The type of a finding described by the action. + // The type of the finding. // // Type is a required field Type *string `locationName:"type" min:"1" type:"string" required:"true"` - // The time stamp at which a finding was last updated. + // The time and date at which the finding was laste updated. // // UpdatedAt is a required field UpdatedAt *string `locationName:"updatedAt" type:"string" required:"true"` @@ -6281,6 +6319,7 @@ func (s *Finding) SetUpdatedAt(v string) *Finding { return s } +// Contains finding criteria information. type FindingCriteria struct { _ struct{} `type:"structure"` @@ -6305,6 +6344,7 @@ func (s *FindingCriteria) SetCriterion(v map[string]*Condition) *FindingCriteria return s } +// Contains information about finding statistics. type FindingStatistics struct { _ struct{} `type:"structure"` @@ -6328,6 +6368,7 @@ func (s *FindingStatistics) SetCountBySeverity(v map[string]*int64) *FindingStat return s } +// Contains information about the type GeoLocation struct { _ struct{} `type:"structure"` @@ -7239,6 +7280,7 @@ func (s *GetThreatIntelSetOutput) SetTags(v map[string]*string) *GetThreatIntelS return s } +// Contains information about the instance profile. type IamInstanceProfile struct { _ struct{} `type:"structure"` @@ -7271,6 +7313,7 @@ func (s *IamInstanceProfile) SetId(v string) *IamInstanceProfile { return s } +// Contains information about the details of an instance. type InstanceDetails struct { _ struct{} `type:"structure"` @@ -7393,6 +7436,7 @@ func (s *InstanceDetails) SetTags(v []*Tag) *InstanceDetails { return s } +// Contains information about the invitation. type Invitation struct { _ struct{} `type:"structure"` @@ -8190,6 +8234,7 @@ func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResource type ListTagsForResourceOutput struct { _ struct{} `type:"structure"` + // The tags associated with the resource. Tags map[string]*string `locationName:"tags" min:"1" type:"map"` } @@ -8310,6 +8355,7 @@ func (s *ListThreatIntelSetsOutput) SetThreatIntelSetIds(v []*string) *ListThrea return s } +// Contains information about the port for the local connection. type LocalPortDetails struct { _ struct{} `type:"structure"` @@ -8342,16 +8388,17 @@ func (s *LocalPortDetails) SetPortName(v string) *LocalPortDetails { return s } +// Contains information about the Master account and invitation. type Master struct { _ struct{} `type:"structure"` - // Master account ID + // The ID of the account used as the Master account. AccountId *string `locationName:"accountId" min:"12" type:"string"` // This value is used to validate the master account to the member account. InvitationId *string `locationName:"invitationId" type:"string"` - // Timestamp at which the invitation was sent + // Timestamp at which the invitation was sent. InvitedAt *string `locationName:"invitedAt" type:"string"` // The status of the relationship between the master and member accounts. @@ -8392,6 +8439,7 @@ func (s *Master) SetRelationshipStatus(v string) *Master { return s } +// Continas information about the member account type Member struct { _ struct{} `type:"structure"` @@ -8479,6 +8527,7 @@ func (s *Member) SetUpdatedAt(v string) *Member { return s } +// Contains information about the network connection. type NetworkConnectionAction struct { _ struct{} `type:"structure"` @@ -8547,6 +8596,7 @@ func (s *NetworkConnectionAction) SetRemotePortDetails(v *RemotePortDetails) *Ne return s } +// Contains information about the network interface. type NetworkInterface struct { _ struct{} `type:"structure"` @@ -8651,6 +8701,7 @@ func (s *NetworkInterface) SetVpcId(v string) *NetworkInterface { return s } +// Continas information about the organization. type Organization struct { _ struct{} `type:"structure"` @@ -8701,6 +8752,7 @@ func (s *Organization) SetOrg(v string) *Organization { return s } +// Contains information about the port probe. type PortProbeAction struct { _ struct{} `type:"structure"` @@ -8733,6 +8785,7 @@ func (s *PortProbeAction) SetPortProbeDetails(v []*PortProbeDetail) *PortProbeAc return s } +// Contains information about the port probe details. type PortProbeDetail struct { _ struct{} `type:"structure"` @@ -8765,6 +8818,7 @@ func (s *PortProbeDetail) SetRemoteIpDetails(v *RemoteIpDetails) *PortProbeDetai return s } +// Contains information about the private IP address. type PrivateIpAddressDetails struct { _ struct{} `type:"structure"` @@ -8797,6 +8851,7 @@ func (s *PrivateIpAddressDetails) SetPrivateIpAddress(v string) *PrivateIpAddres return s } +// Contains information about the product code. type ProductCode struct { _ struct{} `type:"structure"` @@ -8829,6 +8884,7 @@ func (s *ProductCode) SetProductType(v string) *ProductCode { return s } +// Continas information about the remote IP address. type RemoteIpDetails struct { _ struct{} `type:"structure"` @@ -8888,6 +8944,7 @@ func (s *RemoteIpDetails) SetOrganization(v *Organization) *RemoteIpDetails { return s } +// Contains information about the remote port. type RemotePortDetails struct { _ struct{} `type:"structure"` @@ -8920,6 +8977,7 @@ func (s *RemotePortDetails) SetPortName(v string) *RemotePortDetails { return s } +// Contains information about the resource. type Resource struct { _ struct{} `type:"structure"` @@ -8963,6 +9021,7 @@ func (s *Resource) SetResourceType(v string) *Resource { return s } +// Contains information about the security group. type SecurityGroup struct { _ struct{} `type:"structure"` @@ -8995,6 +9054,7 @@ func (s *SecurityGroup) SetGroupName(v string) *SecurityGroup { return s } +// Contains information about the service. type Service struct { _ struct{} `type:"structure"` @@ -9018,6 +9078,9 @@ type Service struct { // finding. EventLastSeen *string `locationName:"eventLastSeen" type:"string"` + // An evidence object associated with the service. + Evidence *Evidence `locationName:"evidence" type:"structure"` + // Resource role information for this finding. ResourceRole *string `locationName:"resourceRole" type:"string"` @@ -9074,6 +9137,12 @@ func (s *Service) SetEventLastSeen(v string) *Service { return s } +// SetEvidence sets the Evidence field's value. +func (s *Service) SetEvidence(v *Evidence) *Service { + s.Evidence = v + return s +} + // SetResourceRole sets the ResourceRole field's value. func (s *Service) SetResourceRole(v string) *Service { s.ResourceRole = &v @@ -9092,6 +9161,7 @@ func (s *Service) SetUserFeedback(v string) *Service { return s } +// Contains information about the criteria for sorting. type SortCriteria struct { _ struct{} `type:"structure"` @@ -9297,6 +9367,7 @@ func (s *StopMonitoringMembersOutput) SetUnprocessedAccounts(v []*UnprocessedAcc return s } +// Contains information about the tag associated with the resource. type Tag struct { _ struct{} `type:"structure"` @@ -9401,6 +9472,41 @@ func (s TagResourceOutput) GoString() string { return s.String() } +// An instance of a threat intelligence detail that constitutes evidence for +// the finding. +type ThreatIntelligenceDetail struct { + _ struct{} `type:"structure"` + + // The name of the threat intelligence list that triggered the finding. + ThreatListName *string `locationName:"threatListName" type:"string"` + + // A list of names of the threats in the threat intelligence list that triggered + // the finding. + ThreatNames []*string `locationName:"threatNames" type:"list"` +} + +// String returns the string representation +func (s ThreatIntelligenceDetail) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ThreatIntelligenceDetail) GoString() string { + return s.String() +} + +// SetThreatListName sets the ThreatListName field's value. +func (s *ThreatIntelligenceDetail) SetThreatListName(v string) *ThreatIntelligenceDetail { + s.ThreatListName = &v + return s +} + +// SetThreatNames sets the ThreatNames field's value. +func (s *ThreatIntelligenceDetail) SetThreatNames(v []*string) *ThreatIntelligenceDetail { + s.ThreatNames = v + return s +} + type UnarchiveFindingsInput struct { _ struct{} `type:"structure"` @@ -9471,6 +9577,7 @@ func (s UnarchiveFindingsOutput) GoString() string { return s.String() } +// Contains information about the accounts that were not processed. type UnprocessedAccount struct { _ struct{} `type:"structure"` diff --git a/service/iot/api.go b/service/iot/api.go index a7dff516945..3e371ea9820 100644 --- a/service/iot/api.go +++ b/service/iot/api.go @@ -17355,7 +17355,7 @@ type AttributePayload struct { // // To remove an attribute, call UpdateThing with an empty attribute value. // - // The merge attribute is only valid when calling UpdateThing. + // The merge attribute is only valid when calling UpdateThing or UpdateThingGroup. Merge *bool `locationName:"merge" type:"boolean"` } @@ -28500,7 +28500,7 @@ type ListAttachedPoliciesInput struct { // When true, recursively list attached policies. Recursive *bool `location:"querystring" locationName:"recursive" type:"boolean"` - // The group for which the policies will be listed. + // The group or principal for which the policies will be listed. // // Target is a required field Target *string `location:"uri" locationName:"target" type:"string" required:"true"` @@ -34440,6 +34440,9 @@ func (s ReplaceTopicRuleOutput) GoString() string { type RepublishAction struct { _ struct{} `type:"structure"` + // The Quality of Service (QoS) level to use when republishing messages. + Qos *int64 `locationName:"qos" type:"integer"` + // The ARN of the IAM role that grants access. // // RoleArn is a required field @@ -34477,6 +34480,12 @@ func (s *RepublishAction) Validate() error { return nil } +// SetQos sets the Qos field's value. +func (s *RepublishAction) SetQos(v int64) *RepublishAction { + s.Qos = &v + return s +} + // SetRoleArn sets the RoleArn field's value. func (s *RepublishAction) SetRoleArn(v string) *RepublishAction { s.RoleArn = &v diff --git a/service/lexruntimeservice/api.go b/service/lexruntimeservice/api.go index 67badc9aba8..e3f036168df 100644 --- a/service/lexruntimeservice/api.go +++ b/service/lexruntimeservice/api.go @@ -11,6 +11,189 @@ import ( "github.com/aws/aws-sdk-go/aws/signer/v4" ) +const opDeleteSession = "DeleteSession" + +// DeleteSessionRequest generates a "aws/request.Request" representing the +// client's request for the DeleteSession operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteSession for more information on using the DeleteSession +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteSessionRequest method. +// req, resp := client.DeleteSessionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/DeleteSession +func (c *LexRuntimeService) DeleteSessionRequest(input *DeleteSessionInput) (req *request.Request, output *DeleteSessionOutput) { + op := &request.Operation{ + Name: opDeleteSession, + HTTPMethod: "DELETE", + HTTPPath: "/bot/{botName}/alias/{botAlias}/user/{userId}/session", + } + + if input == nil { + input = &DeleteSessionInput{} + } + + output = &DeleteSessionOutput{} + req = c.newRequest(op, input, output) + return +} + +// DeleteSession API operation for Amazon Lex Runtime Service. +// +// Removes session information for a specified bot, alias, and user ID. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lex Runtime Service's +// API operation DeleteSession for usage and error information. +// +// Returned Error Codes: +// * ErrCodeNotFoundException "NotFoundException" +// The resource (such as the Amazon Lex bot or an alias) that is referred to +// is not found. +// +// * ErrCodeBadRequestException "BadRequestException" +// Request validation failed, there is no usable message in the context, or +// the bot build failed, is still in progress, or contains unbuilt changes. +// +// * ErrCodeLimitExceededException "LimitExceededException" +// Exceeded a limit. +// +// * ErrCodeInternalFailureException "InternalFailureException" +// Internal service error. Retry the call. +// +// * ErrCodeConflictException "ConflictException" +// Two clients are using the same AWS account, Amazon Lex bot, and user ID. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/DeleteSession +func (c *LexRuntimeService) DeleteSession(input *DeleteSessionInput) (*DeleteSessionOutput, error) { + req, out := c.DeleteSessionRequest(input) + return out, req.Send() +} + +// DeleteSessionWithContext is the same as DeleteSession with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteSession for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LexRuntimeService) DeleteSessionWithContext(ctx aws.Context, input *DeleteSessionInput, opts ...request.Option) (*DeleteSessionOutput, error) { + req, out := c.DeleteSessionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opGetSession = "GetSession" + +// GetSessionRequest generates a "aws/request.Request" representing the +// client's request for the GetSession operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See GetSession for more information on using the GetSession +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the GetSessionRequest method. +// req, resp := client.GetSessionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/GetSession +func (c *LexRuntimeService) GetSessionRequest(input *GetSessionInput) (req *request.Request, output *GetSessionOutput) { + op := &request.Operation{ + Name: opGetSession, + HTTPMethod: "GET", + HTTPPath: "/bot/{botName}/alias/{botAlias}/user/{userId}/session", + } + + if input == nil { + input = &GetSessionInput{} + } + + output = &GetSessionOutput{} + req = c.newRequest(op, input, output) + return +} + +// GetSession API operation for Amazon Lex Runtime Service. +// +// Returns session information for a specified bot, alias, and user ID. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lex Runtime Service's +// API operation GetSession for usage and error information. +// +// Returned Error Codes: +// * ErrCodeNotFoundException "NotFoundException" +// The resource (such as the Amazon Lex bot or an alias) that is referred to +// is not found. +// +// * ErrCodeBadRequestException "BadRequestException" +// Request validation failed, there is no usable message in the context, or +// the bot build failed, is still in progress, or contains unbuilt changes. +// +// * ErrCodeLimitExceededException "LimitExceededException" +// Exceeded a limit. +// +// * ErrCodeInternalFailureException "InternalFailureException" +// Internal service error. Retry the call. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/GetSession +func (c *LexRuntimeService) GetSession(input *GetSessionInput) (*GetSessionOutput, error) { + req, out := c.GetSessionRequest(input) + return out, req.Send() +} + +// GetSessionWithContext is the same as GetSession with the addition of +// the ability to pass a context and additional request options. +// +// See GetSession for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LexRuntimeService) GetSessionWithContext(ctx aws.Context, input *GetSessionInput, opts ...request.Option) (*GetSessionOutput, error) { + req, out := c.GetSessionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opPostContent = "PostContent" // PostContentRequest generates a "aws/request.Request" representing the @@ -104,7 +287,7 @@ func (c *LexRuntimeService) PostContentRequest(input *PostContentInput) (req *re // header is set to ElicitIntent and the x-amz-slot-to-elicit header is omitted. // // In addition, Amazon Lex also returns your application-specific sessionAttributes. -// For more information, see Managing Conversation Context (http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html). +// For more information, see Managing Conversation Context (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -225,8 +408,8 @@ func (c *LexRuntimeService) PostTextRequest(input *PostTextInput) (req *request. // PostText API operation for Amazon Lex Runtime Service. // -// Sends user input (text-only) to Amazon Lex. Client applications can use this -// API to send requests to Amazon Lex at runtime. Amazon Lex then interprets +// Sends user input (text or SSML) to Amazon Lex. Client applications can use +// this API to send requests to Amazon Lex at runtime. Amazon Lex then interprets // the user input using the machine learning model it built for the bot. // // In response, Amazon Lex returns the next message to convey to the user an @@ -266,7 +449,7 @@ func (c *LexRuntimeService) PostTextRequest(input *PostTextInput) (req *request. // set to ElicitIntent and slotToElicit is set to null. // // In addition, Amazon Lex also returns your application-specific sessionAttributes. -// For more information, see Managing Conversation Context (http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html). +// For more information, see Managing Conversation Context (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html). // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -334,6 +517,122 @@ func (c *LexRuntimeService) PostTextWithContext(ctx aws.Context, input *PostText return out, req.Send() } +const opPutSession = "PutSession" + +// PutSessionRequest generates a "aws/request.Request" representing the +// client's request for the PutSession operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See PutSession for more information on using the PutSession +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the PutSessionRequest method. +// req, resp := client.PutSessionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PutSession +func (c *LexRuntimeService) PutSessionRequest(input *PutSessionInput) (req *request.Request, output *PutSessionOutput) { + op := &request.Operation{ + Name: opPutSession, + HTTPMethod: "POST", + HTTPPath: "/bot/{botName}/alias/{botAlias}/user/{userId}/session", + } + + if input == nil { + input = &PutSessionInput{} + } + + output = &PutSessionOutput{} + req = c.newRequest(op, input, output) + return +} + +// PutSession API operation for Amazon Lex Runtime Service. +// +// Creates a new session or modifies an existing session with an Amazon Lex +// bot. Use this operation to enable your application to set the state of the +// bot. +// +// For more information, see Managing Sessions (https://docs.aws.amazon.com/lex/latest/dg/how-session-api.html). +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Lex Runtime Service's +// API operation PutSession for usage and error information. +// +// Returned Error Codes: +// * ErrCodeNotFoundException "NotFoundException" +// The resource (such as the Amazon Lex bot or an alias) that is referred to +// is not found. +// +// * ErrCodeBadRequestException "BadRequestException" +// Request validation failed, there is no usable message in the context, or +// the bot build failed, is still in progress, or contains unbuilt changes. +// +// * ErrCodeLimitExceededException "LimitExceededException" +// Exceeded a limit. +// +// * ErrCodeInternalFailureException "InternalFailureException" +// Internal service error. Retry the call. +// +// * ErrCodeConflictException "ConflictException" +// Two clients are using the same AWS account, Amazon Lex bot, and user ID. +// +// * ErrCodeNotAcceptableException "NotAcceptableException" +// The accept header in the request does not have a valid value. +// +// * ErrCodeDependencyFailedException "DependencyFailedException" +// One of the dependencies, such as AWS Lambda or Amazon Polly, threw an exception. +// For example, +// +// * If Amazon Lex does not have sufficient permissions to call a Lambda +// function. +// +// * If a Lambda function takes longer than 30 seconds to execute. +// +// * If a fulfillment Lambda function returns a Delegate dialog action without +// removing any slot values. +// +// * ErrCodeBadGatewayException "BadGatewayException" +// Either the Amazon Lex bot is still building, or one of the dependent services +// (Amazon Polly, AWS Lambda) failed with an internal service error. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/runtime.lex-2016-11-28/PutSession +func (c *LexRuntimeService) PutSession(input *PutSessionInput) (*PutSessionOutput, error) { + req, out := c.PutSessionRequest(input) + return out, req.Send() +} + +// PutSessionWithContext is the same as PutSession with the addition of +// the ability to pass a context and additional request options. +// +// See PutSession for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *LexRuntimeService) PutSessionWithContext(ctx aws.Context, input *PutSessionInput, opts ...request.Option) (*PutSessionOutput, error) { + req, out := c.PutSessionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + // Represents an option to be shown on the client platform (Facebook, Slack, // etc.) type Button struct { @@ -374,64 +673,560 @@ func (s *Button) SetValue(v string) *Button { return s } -// Represents an option rendered to the user when a prompt is shown. It could -// be an image, a button, a link, or text. -type GenericAttachment struct { +type DeleteSessionInput struct { _ struct{} `type:"structure"` - // The URL of an attachment to the response card. - AttachmentLinkUrl *string `locationName:"attachmentLinkUrl" min:"1" type:"string"` + // The alias in use for the bot that contains the session data. + // + // BotAlias is a required field + BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"` - // The list of options to show to the user. - Buttons []*Button `locationName:"buttons" type:"list"` + // The name of the bot that contains the session data. + // + // BotName is a required field + BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"` + + // The identifier of the user associated with the session data. + // + // UserId is a required field + UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"` +} + +// String returns the string representation +func (s DeleteSessionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteSessionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteSessionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteSessionInput"} + if s.BotAlias == nil { + invalidParams.Add(request.NewErrParamRequired("BotAlias")) + } + if s.BotAlias != nil && len(*s.BotAlias) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BotAlias", 1)) + } + if s.BotName == nil { + invalidParams.Add(request.NewErrParamRequired("BotName")) + } + if s.BotName != nil && len(*s.BotName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BotName", 1)) + } + if s.UserId == nil { + invalidParams.Add(request.NewErrParamRequired("UserId")) + } + if s.UserId != nil && len(*s.UserId) < 2 { + invalidParams.Add(request.NewErrParamMinLen("UserId", 2)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBotAlias sets the BotAlias field's value. +func (s *DeleteSessionInput) SetBotAlias(v string) *DeleteSessionInput { + s.BotAlias = &v + return s +} + +// SetBotName sets the BotName field's value. +func (s *DeleteSessionInput) SetBotName(v string) *DeleteSessionInput { + s.BotName = &v + return s +} + +// SetUserId sets the UserId field's value. +func (s *DeleteSessionInput) SetUserId(v string) *DeleteSessionInput { + s.UserId = &v + return s +} + +type DeleteSessionOutput struct { + _ struct{} `type:"structure"` + + // The alias in use for the bot associated with the session data. + BotAlias *string `locationName:"botAlias" type:"string"` + + // The name of the bot associated with the session data. + BotName *string `locationName:"botName" type:"string"` + + // The unique identifier for the session. + SessionId *string `locationName:"sessionId" type:"string"` + + // The ID of the client application user. + UserId *string `locationName:"userId" min:"2" type:"string"` +} + +// String returns the string representation +func (s DeleteSessionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DeleteSessionOutput) GoString() string { + return s.String() +} + +// SetBotAlias sets the BotAlias field's value. +func (s *DeleteSessionOutput) SetBotAlias(v string) *DeleteSessionOutput { + s.BotAlias = &v + return s +} + +// SetBotName sets the BotName field's value. +func (s *DeleteSessionOutput) SetBotName(v string) *DeleteSessionOutput { + s.BotName = &v + return s +} + +// SetSessionId sets the SessionId field's value. +func (s *DeleteSessionOutput) SetSessionId(v string) *DeleteSessionOutput { + s.SessionId = &v + return s +} + +// SetUserId sets the UserId field's value. +func (s *DeleteSessionOutput) SetUserId(v string) *DeleteSessionOutput { + s.UserId = &v + return s +} + +// Describes the next action that the bot should take in its interaction with +// the user and provides information about the context in which the action takes +// place. Use the DialogAction data type to set the interaction to a specific +// state, or to return the interaction to a previous state. +type DialogAction struct { + _ struct{} `type:"structure"` + + // The fulfillment state of the intent. The possible values are: + // + // * Failed - The Lambda function associated with the intent failed to fulfill + // the intent. + // + // * Fulfilled - The intent has fulfilled by the Lambda function associated + // with the intent. + // + // * ReadyForFulfillment - All of the information necessary for the intent + // is present and the intent ready to be fulfilled by the client application. + FulfillmentState *string `locationName:"fulfillmentState" type:"string" enum:"FulfillmentState"` + + // The name of the intent. + IntentName *string `locationName:"intentName" type:"string"` + + // The message that should be shown to the user. If you don't specify a message, + // Amazon Lex will use the message configured for the intent. + Message *string `locationName:"message" min:"1" type:"string" sensitive:"true"` + + // * PlainText - The message contains plain UTF-8 text. + // + // * CustomPayload - The message is a custom format for the client. + // + // * SSML - The message contains text formatted for voice output. + // + // * Composite - The message contains an escaped JSON object containing one + // or more messages. For more information, see Message Groups (https://docs.aws.amazon.com/lex/latest/dg/howitworks-manage-prompts.html). + MessageFormat *string `locationName:"messageFormat" type:"string" enum:"MessageFormatType"` + + // The name of the slot that should be elicited from the user. + SlotToElicit *string `locationName:"slotToElicit" type:"string"` + + // Map of the slots that have been gathered and their values. + Slots map[string]*string `locationName:"slots" type:"map" sensitive:"true"` + + // The next action that the bot should take in its interaction with the user. + // The possible values are: + // + // * ConfirmIntent - The next action is asking the user if the intent is + // complete and ready to be fulfilled. This is a yes/no question such as + // "Place the order?" + // + // * Close - Indicates that the there will not be a response from the user. + // For example, the statement "Your order has been placed" does not require + // a response. + // + // * Delegate - The next action is determined by Amazon Lex. + // + // * ElicitIntent - The next action is to determine the intent that the user + // wants to fulfill. + // + // * ElicitSlot - The next action is to elicit a slot value from the user. + // + // Type is a required field + Type *string `locationName:"type" type:"string" required:"true" enum:"DialogActionType"` +} + +// String returns the string representation +func (s DialogAction) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DialogAction) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DialogAction) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DialogAction"} + if s.Message != nil && len(*s.Message) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Message", 1)) + } + if s.Type == nil { + invalidParams.Add(request.NewErrParamRequired("Type")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFulfillmentState sets the FulfillmentState field's value. +func (s *DialogAction) SetFulfillmentState(v string) *DialogAction { + s.FulfillmentState = &v + return s +} + +// SetIntentName sets the IntentName field's value. +func (s *DialogAction) SetIntentName(v string) *DialogAction { + s.IntentName = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *DialogAction) SetMessage(v string) *DialogAction { + s.Message = &v + return s +} + +// SetMessageFormat sets the MessageFormat field's value. +func (s *DialogAction) SetMessageFormat(v string) *DialogAction { + s.MessageFormat = &v + return s +} + +// SetSlotToElicit sets the SlotToElicit field's value. +func (s *DialogAction) SetSlotToElicit(v string) *DialogAction { + s.SlotToElicit = &v + return s +} + +// SetSlots sets the Slots field's value. +func (s *DialogAction) SetSlots(v map[string]*string) *DialogAction { + s.Slots = v + return s +} + +// SetType sets the Type field's value. +func (s *DialogAction) SetType(v string) *DialogAction { + s.Type = &v + return s +} + +// Represents an option rendered to the user when a prompt is shown. It could +// be an image, a button, a link, or text. +type GenericAttachment struct { + _ struct{} `type:"structure"` + + // The URL of an attachment to the response card. + AttachmentLinkUrl *string `locationName:"attachmentLinkUrl" min:"1" type:"string"` + + // The list of options to show to the user. + Buttons []*Button `locationName:"buttons" type:"list"` + + // The URL of an image that is displayed to the user. + ImageUrl *string `locationName:"imageUrl" min:"1" type:"string"` + + // The subtitle shown below the title. + SubTitle *string `locationName:"subTitle" min:"1" type:"string"` + + // The title of the option. + Title *string `locationName:"title" min:"1" type:"string"` +} + +// String returns the string representation +func (s GenericAttachment) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GenericAttachment) GoString() string { + return s.String() +} + +// SetAttachmentLinkUrl sets the AttachmentLinkUrl field's value. +func (s *GenericAttachment) SetAttachmentLinkUrl(v string) *GenericAttachment { + s.AttachmentLinkUrl = &v + return s +} + +// SetButtons sets the Buttons field's value. +func (s *GenericAttachment) SetButtons(v []*Button) *GenericAttachment { + s.Buttons = v + return s +} + +// SetImageUrl sets the ImageUrl field's value. +func (s *GenericAttachment) SetImageUrl(v string) *GenericAttachment { + s.ImageUrl = &v + return s +} + +// SetSubTitle sets the SubTitle field's value. +func (s *GenericAttachment) SetSubTitle(v string) *GenericAttachment { + s.SubTitle = &v + return s +} + +// SetTitle sets the Title field's value. +func (s *GenericAttachment) SetTitle(v string) *GenericAttachment { + s.Title = &v + return s +} + +type GetSessionInput struct { + _ struct{} `type:"structure"` + + // The alias in use for the bot that contains the session data. + // + // BotAlias is a required field + BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"` + + // The name of the bot that contains the session data. + // + // BotName is a required field + BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"` + + // The ID of the client application user. Amazon Lex uses this to identify a + // user's conversation with your bot. + // + // UserId is a required field + UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"` +} + +// String returns the string representation +func (s GetSessionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetSessionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *GetSessionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "GetSessionInput"} + if s.BotAlias == nil { + invalidParams.Add(request.NewErrParamRequired("BotAlias")) + } + if s.BotAlias != nil && len(*s.BotAlias) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BotAlias", 1)) + } + if s.BotName == nil { + invalidParams.Add(request.NewErrParamRequired("BotName")) + } + if s.BotName != nil && len(*s.BotName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BotName", 1)) + } + if s.UserId == nil { + invalidParams.Add(request.NewErrParamRequired("UserId")) + } + if s.UserId != nil && len(*s.UserId) < 2 { + invalidParams.Add(request.NewErrParamMinLen("UserId", 2)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetBotAlias sets the BotAlias field's value. +func (s *GetSessionInput) SetBotAlias(v string) *GetSessionInput { + s.BotAlias = &v + return s +} + +// SetBotName sets the BotName field's value. +func (s *GetSessionInput) SetBotName(v string) *GetSessionInput { + s.BotName = &v + return s +} + +// SetUserId sets the UserId field's value. +func (s *GetSessionInput) SetUserId(v string) *GetSessionInput { + s.UserId = &v + return s +} + +type GetSessionOutput struct { + _ struct{} `type:"structure"` + + // Describes the current state of the bot. + DialogAction *DialogAction `locationName:"dialogAction" type:"structure"` + + // An array of information about the intents used in the session. The array + // can contain a maximum of three summaries. If more than three intents are + // used in the session, the recentIntentSummaryView operation contains information + // about the last three intents used. + RecentIntentSummaryView []*IntentSummary `locationName:"recentIntentSummaryView" type:"list"` + + // Map of key/value pairs representing the session-specific context information. + // It contains application information passed between Amazon Lex and a client + // application. + SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map" sensitive:"true"` + + // A unique identifier for the session. + SessionId *string `locationName:"sessionId" type:"string"` +} + +// String returns the string representation +func (s GetSessionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s GetSessionOutput) GoString() string { + return s.String() +} + +// SetDialogAction sets the DialogAction field's value. +func (s *GetSessionOutput) SetDialogAction(v *DialogAction) *GetSessionOutput { + s.DialogAction = v + return s +} + +// SetRecentIntentSummaryView sets the RecentIntentSummaryView field's value. +func (s *GetSessionOutput) SetRecentIntentSummaryView(v []*IntentSummary) *GetSessionOutput { + s.RecentIntentSummaryView = v + return s +} + +// SetSessionAttributes sets the SessionAttributes field's value. +func (s *GetSessionOutput) SetSessionAttributes(v map[string]*string) *GetSessionOutput { + s.SessionAttributes = v + return s +} + +// SetSessionId sets the SessionId field's value. +func (s *GetSessionOutput) SetSessionId(v string) *GetSessionOutput { + s.SessionId = &v + return s +} + +// Provides information about the state of an intent. You can use this information +// to get the current state of an intent so that you can process the intent, +// or so that you can return the intent to its previous state. +type IntentSummary struct { + _ struct{} `type:"structure"` + + // The status of the intent after the user responds to the confirmation prompt. + // If the user confirms the intent, Amazon Lex sets this field to Confirmed. + // If the user denies the intent, Amazon Lex sets this value to Denied. The + // possible values are: + // + // * Confirmed - The user has responded "Yes" to the confirmation prompt, + // confirming that the intent is complete and that it is ready to be fulfilled. + // + // * Denied - The user has responded "No" to the confirmation prompt. + // + // * None - The user has never been prompted for confirmation; or, the user + // was prompted but did not confirm or deny the prompt. + ConfirmationStatus *string `locationName:"confirmationStatus" type:"string" enum:"ConfirmationStatus"` + + // The next action that the bot should take in its interaction with the user. + // The possible values are: + // + // * ConfirmIntent - The next action is asking the user if the intent is + // complete and ready to be fulfilled. This is a yes/no question such as + // "Place the order?" + // + // * Close - Indicates that the there will not be a response from the user. + // For example, the statement "Your order has been placed" does not require + // a response. + // + // * ElicitIntent - The next action is to determine the intent that the user + // wants to fulfill. + // + // * ElicitSlot - The next action is to elicit a slot value from the user. + // + // DialogActionType is a required field + DialogActionType *string `locationName:"dialogActionType" type:"string" required:"true" enum:"DialogActionType"` + + // The fulfillment state of the intent. The possible values are: + // + // * Failed - The Lambda function associated with the intent failed to fulfill + // the intent. + // + // * Fulfilled - The intent has fulfilled by the Lambda function associated + // with the intent. + // + // * ReadyForFulfillment - All of the information necessary for the intent + // is present and the intent ready to be fulfilled by the client application. + FulfillmentState *string `locationName:"fulfillmentState" type:"string" enum:"FulfillmentState"` - // The URL of an image that is displayed to the user. - ImageUrl *string `locationName:"imageUrl" min:"1" type:"string"` + // The name of the intent. + IntentName *string `locationName:"intentName" type:"string"` - // The subtitle shown below the title. - SubTitle *string `locationName:"subTitle" min:"1" type:"string"` + // The next slot to elicit from the user. If there is not slot to elicit, the + // field is blank. + SlotToElicit *string `locationName:"slotToElicit" type:"string"` - // The title of the option. - Title *string `locationName:"title" min:"1" type:"string"` + // Map of the slots that have been gathered and their values. + Slots map[string]*string `locationName:"slots" type:"map" sensitive:"true"` } // String returns the string representation -func (s GenericAttachment) String() string { +func (s IntentSummary) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s GenericAttachment) GoString() string { +func (s IntentSummary) GoString() string { return s.String() } -// SetAttachmentLinkUrl sets the AttachmentLinkUrl field's value. -func (s *GenericAttachment) SetAttachmentLinkUrl(v string) *GenericAttachment { - s.AttachmentLinkUrl = &v +// SetConfirmationStatus sets the ConfirmationStatus field's value. +func (s *IntentSummary) SetConfirmationStatus(v string) *IntentSummary { + s.ConfirmationStatus = &v return s } -// SetButtons sets the Buttons field's value. -func (s *GenericAttachment) SetButtons(v []*Button) *GenericAttachment { - s.Buttons = v +// SetDialogActionType sets the DialogActionType field's value. +func (s *IntentSummary) SetDialogActionType(v string) *IntentSummary { + s.DialogActionType = &v return s } -// SetImageUrl sets the ImageUrl field's value. -func (s *GenericAttachment) SetImageUrl(v string) *GenericAttachment { - s.ImageUrl = &v +// SetFulfillmentState sets the FulfillmentState field's value. +func (s *IntentSummary) SetFulfillmentState(v string) *IntentSummary { + s.FulfillmentState = &v return s } -// SetSubTitle sets the SubTitle field's value. -func (s *GenericAttachment) SetSubTitle(v string) *GenericAttachment { - s.SubTitle = &v +// SetIntentName sets the IntentName field's value. +func (s *IntentSummary) SetIntentName(v string) *IntentSummary { + s.IntentName = &v return s } -// SetTitle sets the Title field's value. -func (s *GenericAttachment) SetTitle(v string) *GenericAttachment { - s.Title = &v +// SetSlotToElicit sets the SlotToElicit field's value. +func (s *IntentSummary) SetSlotToElicit(v string) *IntentSummary { + s.SlotToElicit = &v + return s +} + +// SetSlots sets the Slots field's value. +func (s *IntentSummary) SetSlots(v map[string]*string) *IntentSummary { + s.Slots = v return s } @@ -449,9 +1244,13 @@ type PostContentInput struct { // * If the value begins with audio/, Amazon Lex returns speech in the response. // Amazon Lex uses Amazon Polly to generate the speech (using the configuration // you specified in the Accept header). For example, if you specify audio/mpeg - // as the value, Amazon Lex returns speech in the MPEG format. The following - // are the accepted values: audio/mpeg audio/ogg audio/pcm text/plain; charset=utf-8 - // audio/* (defaults to mpeg) + // as the value, Amazon Lex returns speech in the MPEG format. + // + // * If the value is audio/pcm, the speech returned is audio/pcm in 16-bit, + // little endian format. + // + // * The following are the accepted values: audio/mpeg audio/ogg audio/pcm + // text/plain; charset=utf-8 audio/* (defaults to mpeg) Accept *string `location:"header" locationName:"Accept" type:"string"` // Alias of the Amazon Lex bot. @@ -506,7 +1305,7 @@ type PostContentInput struct { // The namespace x-amz-lex: is reserved for special attributes. Don't create // any request attributes with the prefix x-amz-lex:. // - // For more information, see Setting Request Attributes (http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs). + // For more information, see Setting Request Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs). RequestAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-request-attributes" type:"jsonvalue"` // You pass this value as the x-amz-lex-session-attributes HTTP header. @@ -516,7 +1315,7 @@ type PostContentInput struct { // and values. The total size of the sessionAttributes and requestAttributes // headers is limited to 12 KB. // - // For more information, see Setting Session Attributes (http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs). + // For more information, see Setting Session Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs). SessionAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-session-attributes" type:"jsonvalue"` // The ID of the client application user. Amazon Lex uses this to identify a @@ -705,7 +1504,7 @@ type PostContentOutput struct { // or from a Lambda function. // // If the intent is not configured with a Lambda function, or if the Lambda - // function returned Delegate as the dialogAction.type its response, Amazon + // function returned Delegate as the dialogAction.type in its response, Amazon // Lex decides on the next course of action and selects an appropriate message // from the bot's configuration based on the current interaction context. For // example, if Amazon Lex isn't able to understand user input, it uses a clarification @@ -742,7 +1541,7 @@ type PostContentOutput struct { SlotToElicit *string `location:"header" locationName:"x-amz-lex-slot-to-elicit" type:"string"` // Map of zero or more intent slots (name/value pairs) Amazon Lex detected from - // the user input during the conversation. + // the user input during the conversation. The field is base-64 encoded. // // Amazon Lex creates a resolution list containing likely values for a slot. // The value that it returns is determined by the valueSelectionStrategy selected @@ -848,12 +1647,12 @@ type PostTextInput struct { // The namespace x-amz-lex: is reserved for special attributes. Don't create // any request attributes with the prefix x-amz-lex:. // - // For more information, see Setting Request Attributes (http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs). + // For more information, see Setting Request Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-request-attribs). RequestAttributes map[string]*string `locationName:"requestAttributes" type:"map" sensitive:"true"` // Application-specific information passed between Amazon Lex and a client application. // - // For more information, see Setting Session Attributes (http://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs). + // For more information, see Setting Session Attributes (https://docs.aws.amazon.com/lex/latest/dg/context-mgmt.html#context-mgmt-session-attribs). SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map" sensitive:"true"` // The ID of the client application user. Amazon Lex uses this to identify a @@ -1123,6 +1922,272 @@ func (s *PostTextOutput) SetSlots(v map[string]*string) *PostTextOutput { return s } +type PutSessionInput struct { + _ struct{} `type:"structure"` + + // The message that Amazon Lex returns in the response can be either text or + // speech based depending on the value of this field. + // + // * If the value is text/plain; charset=utf-8, Amazon Lex returns text in + // the response. + // + // * If the value begins with audio/, Amazon Lex returns speech in the response. + // Amazon Lex uses Amazon Polly to generate the speech in the configuration + // that you specify. For example, if you specify audio/mpeg as the value, + // Amazon Lex returns speech in the MPEG format. + // + // * If the value is audio/pcm, the speech is returned as audio/pcm in 16-bit, + // little endian format. + // + // * The following are the accepted values: audio/mpeg audio/ogg audio/pcm + // audio/* (defaults to mpeg) text/plain; charset=utf-8 + Accept *string `location:"header" locationName:"Accept" type:"string"` + + // The alias in use for the bot that contains the session data. + // + // BotAlias is a required field + BotAlias *string `location:"uri" locationName:"botAlias" type:"string" required:"true"` + + // The name of the bot that contains the session data. + // + // BotName is a required field + BotName *string `location:"uri" locationName:"botName" type:"string" required:"true"` + + // Sets the next action that the bot should take to fulfill the conversation. + DialogAction *DialogAction `locationName:"dialogAction" type:"structure"` + + // Map of key/value pairs representing the session-specific context information. + // It contains application information passed between Amazon Lex and a client + // application. + SessionAttributes map[string]*string `locationName:"sessionAttributes" type:"map" sensitive:"true"` + + // The ID of the client application user. Amazon Lex uses this to identify a + // user's conversation with your bot. + // + // UserId is a required field + UserId *string `location:"uri" locationName:"userId" min:"2" type:"string" required:"true"` +} + +// String returns the string representation +func (s PutSessionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PutSessionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PutSessionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PutSessionInput"} + if s.BotAlias == nil { + invalidParams.Add(request.NewErrParamRequired("BotAlias")) + } + if s.BotAlias != nil && len(*s.BotAlias) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BotAlias", 1)) + } + if s.BotName == nil { + invalidParams.Add(request.NewErrParamRequired("BotName")) + } + if s.BotName != nil && len(*s.BotName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("BotName", 1)) + } + if s.UserId == nil { + invalidParams.Add(request.NewErrParamRequired("UserId")) + } + if s.UserId != nil && len(*s.UserId) < 2 { + invalidParams.Add(request.NewErrParamMinLen("UserId", 2)) + } + if s.DialogAction != nil { + if err := s.DialogAction.Validate(); err != nil { + invalidParams.AddNested("DialogAction", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAccept sets the Accept field's value. +func (s *PutSessionInput) SetAccept(v string) *PutSessionInput { + s.Accept = &v + return s +} + +// SetBotAlias sets the BotAlias field's value. +func (s *PutSessionInput) SetBotAlias(v string) *PutSessionInput { + s.BotAlias = &v + return s +} + +// SetBotName sets the BotName field's value. +func (s *PutSessionInput) SetBotName(v string) *PutSessionInput { + s.BotName = &v + return s +} + +// SetDialogAction sets the DialogAction field's value. +func (s *PutSessionInput) SetDialogAction(v *DialogAction) *PutSessionInput { + s.DialogAction = v + return s +} + +// SetSessionAttributes sets the SessionAttributes field's value. +func (s *PutSessionInput) SetSessionAttributes(v map[string]*string) *PutSessionInput { + s.SessionAttributes = v + return s +} + +// SetUserId sets the UserId field's value. +func (s *PutSessionInput) SetUserId(v string) *PutSessionInput { + s.UserId = &v + return s +} + +type PutSessionOutput struct { + _ struct{} `type:"structure" payload:"AudioStream"` + + // The audio version of the message to convey to the user. + AudioStream io.ReadCloser `locationName:"audioStream" type:"blob"` + + // Content type as specified in the Accept HTTP header in the request. + ContentType *string `location:"header" locationName:"Content-Type" type:"string"` + + // * ConfirmIntent - Amazon Lex is expecting a "yes" or "no" response to + // confirm the intent before fulfilling an intent. + // + // * ElicitIntent - Amazon Lex wants to elicit the user's intent. + // + // * ElicitSlot - Amazon Lex is expecting the value of a slot for the current + // intent. + // + // * Failed - Conveys that the conversation with the user has failed. This + // can happen for various reasons, including the user does not provide an + // appropriate response to prompts from the service, or if the Lambda function + // fails to fulfill the intent. + // + // * Fulfilled - Conveys that the Lambda function has sucessfully fulfilled + // the intent. + // + // * ReadyForFulfillment - Conveys that the client has to fulfill the intent. + DialogState *string `location:"header" locationName:"x-amz-lex-dialog-state" type:"string" enum:"DialogState"` + + // The name of the current intent. + IntentName *string `location:"header" locationName:"x-amz-lex-intent-name" type:"string"` + + // The next message that should be presented to the user. + Message *string `location:"header" locationName:"x-amz-lex-message" min:"1" type:"string" sensitive:"true"` + + // The format of the response message. One of the following values: + // + // * PlainText - The message contains plain UTF-8 text. + // + // * CustomPayload - The message is a custom format for the client. + // + // * SSML - The message contains text formatted for voice output. + // + // * Composite - The message contains an escaped JSON object containing one + // or more messages from the groups that messages were assigned to when the + // intent was created. + MessageFormat *string `location:"header" locationName:"x-amz-lex-message-format" type:"string" enum:"MessageFormatType"` + + // Map of key/value pairs representing session-specific context information. + SessionAttributes aws.JSONValue `location:"header" locationName:"x-amz-lex-session-attributes" type:"jsonvalue"` + + // A unique identifier for the session. + SessionId *string `location:"header" locationName:"x-amz-lex-session-id" type:"string"` + + // If the dialogState is ElicitSlot, returns the name of the slot for which + // Amazon Lex is eliciting a value. + SlotToElicit *string `location:"header" locationName:"x-amz-lex-slot-to-elicit" type:"string"` + + // Map of zero or more intent slots Amazon Lex detected from the user input + // during the conversation. + // + // Amazon Lex creates a resolution list containing likely values for a slot. + // The value that it returns is determined by the valueSelectionStrategy selected + // when the slot type was created or updated. If valueSelectionStrategy is set + // to ORIGINAL_VALUE, the value provided by the user is returned, if the user + // value is similar to the slot values. If valueSelectionStrategy is set to + // TOP_RESOLUTION Amazon Lex returns the first value in the resolution list + // or, if there is no resolution list, null. If you don't specify a valueSelectionStrategy + // the default is ORIGINAL_VALUE. + Slots aws.JSONValue `location:"header" locationName:"x-amz-lex-slots" type:"jsonvalue"` +} + +// String returns the string representation +func (s PutSessionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PutSessionOutput) GoString() string { + return s.String() +} + +// SetAudioStream sets the AudioStream field's value. +func (s *PutSessionOutput) SetAudioStream(v io.ReadCloser) *PutSessionOutput { + s.AudioStream = v + return s +} + +// SetContentType sets the ContentType field's value. +func (s *PutSessionOutput) SetContentType(v string) *PutSessionOutput { + s.ContentType = &v + return s +} + +// SetDialogState sets the DialogState field's value. +func (s *PutSessionOutput) SetDialogState(v string) *PutSessionOutput { + s.DialogState = &v + return s +} + +// SetIntentName sets the IntentName field's value. +func (s *PutSessionOutput) SetIntentName(v string) *PutSessionOutput { + s.IntentName = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *PutSessionOutput) SetMessage(v string) *PutSessionOutput { + s.Message = &v + return s +} + +// SetMessageFormat sets the MessageFormat field's value. +func (s *PutSessionOutput) SetMessageFormat(v string) *PutSessionOutput { + s.MessageFormat = &v + return s +} + +// SetSessionAttributes sets the SessionAttributes field's value. +func (s *PutSessionOutput) SetSessionAttributes(v aws.JSONValue) *PutSessionOutput { + s.SessionAttributes = v + return s +} + +// SetSessionId sets the SessionId field's value. +func (s *PutSessionOutput) SetSessionId(v string) *PutSessionOutput { + s.SessionId = &v + return s +} + +// SetSlotToElicit sets the SlotToElicit field's value. +func (s *PutSessionOutput) SetSlotToElicit(v string) *PutSessionOutput { + s.SlotToElicit = &v + return s +} + +// SetSlots sets the Slots field's value. +func (s *PutSessionOutput) SetSlots(v aws.JSONValue) *PutSessionOutput { + s.Slots = v + return s +} + // If you configure a response card when creating your bots, Amazon Lex substitutes // the session attributes and slot values that are available, and then returns // it. The response card can also come from a Lambda function ( dialogCodeHook @@ -1168,11 +2233,39 @@ func (s *ResponseCard) SetVersion(v string) *ResponseCard { return s } +const ( + // ConfirmationStatusNone is a ConfirmationStatus enum value + ConfirmationStatusNone = "None" + + // ConfirmationStatusConfirmed is a ConfirmationStatus enum value + ConfirmationStatusConfirmed = "Confirmed" + + // ConfirmationStatusDenied is a ConfirmationStatus enum value + ConfirmationStatusDenied = "Denied" +) + const ( // ContentTypeApplicationVndAmazonawsCardGeneric is a ContentType enum value ContentTypeApplicationVndAmazonawsCardGeneric = "application/vnd.amazonaws.card.generic" ) +const ( + // DialogActionTypeElicitIntent is a DialogActionType enum value + DialogActionTypeElicitIntent = "ElicitIntent" + + // DialogActionTypeConfirmIntent is a DialogActionType enum value + DialogActionTypeConfirmIntent = "ConfirmIntent" + + // DialogActionTypeElicitSlot is a DialogActionType enum value + DialogActionTypeElicitSlot = "ElicitSlot" + + // DialogActionTypeClose is a DialogActionType enum value + DialogActionTypeClose = "Close" + + // DialogActionTypeDelegate is a DialogActionType enum value + DialogActionTypeDelegate = "Delegate" +) + const ( // DialogStateElicitIntent is a DialogState enum value DialogStateElicitIntent = "ElicitIntent" @@ -1193,6 +2286,17 @@ const ( DialogStateFailed = "Failed" ) +const ( + // FulfillmentStateFulfilled is a FulfillmentState enum value + FulfillmentStateFulfilled = "Fulfilled" + + // FulfillmentStateFailed is a FulfillmentState enum value + FulfillmentStateFailed = "Failed" + + // FulfillmentStateReadyForFulfillment is a FulfillmentState enum value + FulfillmentStateReadyForFulfillment = "ReadyForFulfillment" +) + const ( // MessageFormatTypePlainText is a MessageFormatType enum value MessageFormatTypePlainText = "PlainText" diff --git a/service/lexruntimeservice/lexruntimeserviceiface/interface.go b/service/lexruntimeservice/lexruntimeserviceiface/interface.go index 4db7b4192ff..aeab1309332 100644 --- a/service/lexruntimeservice/lexruntimeserviceiface/interface.go +++ b/service/lexruntimeservice/lexruntimeserviceiface/interface.go @@ -26,7 +26,7 @@ import ( // // myFunc uses an SDK service client to make a request to // // Amazon Lex Runtime Service. // func myFunc(svc lexruntimeserviceiface.LexRuntimeServiceAPI) bool { -// // Make svc.PostContent request +// // Make svc.DeleteSession request // } // // func main() { @@ -42,7 +42,7 @@ import ( // type mockLexRuntimeServiceClient struct { // lexruntimeserviceiface.LexRuntimeServiceAPI // } -// func (m *mockLexRuntimeServiceClient) PostContent(input *lexruntimeservice.PostContentInput) (*lexruntimeservice.PostContentOutput, error) { +// func (m *mockLexRuntimeServiceClient) DeleteSession(input *lexruntimeservice.DeleteSessionInput) (*lexruntimeservice.DeleteSessionOutput, error) { // // mock response/functionality // } // @@ -60,6 +60,14 @@ import ( // and waiters. Its suggested to use the pattern above for testing, or using // tooling to generate mocks to satisfy the interfaces. type LexRuntimeServiceAPI interface { + DeleteSession(*lexruntimeservice.DeleteSessionInput) (*lexruntimeservice.DeleteSessionOutput, error) + DeleteSessionWithContext(aws.Context, *lexruntimeservice.DeleteSessionInput, ...request.Option) (*lexruntimeservice.DeleteSessionOutput, error) + DeleteSessionRequest(*lexruntimeservice.DeleteSessionInput) (*request.Request, *lexruntimeservice.DeleteSessionOutput) + + GetSession(*lexruntimeservice.GetSessionInput) (*lexruntimeservice.GetSessionOutput, error) + GetSessionWithContext(aws.Context, *lexruntimeservice.GetSessionInput, ...request.Option) (*lexruntimeservice.GetSessionOutput, error) + GetSessionRequest(*lexruntimeservice.GetSessionInput) (*request.Request, *lexruntimeservice.GetSessionOutput) + PostContent(*lexruntimeservice.PostContentInput) (*lexruntimeservice.PostContentOutput, error) PostContentWithContext(aws.Context, *lexruntimeservice.PostContentInput, ...request.Option) (*lexruntimeservice.PostContentOutput, error) PostContentRequest(*lexruntimeservice.PostContentInput) (*request.Request, *lexruntimeservice.PostContentOutput) @@ -67,6 +75,10 @@ type LexRuntimeServiceAPI interface { PostText(*lexruntimeservice.PostTextInput) (*lexruntimeservice.PostTextOutput, error) PostTextWithContext(aws.Context, *lexruntimeservice.PostTextInput, ...request.Option) (*lexruntimeservice.PostTextOutput, error) PostTextRequest(*lexruntimeservice.PostTextInput) (*request.Request, *lexruntimeservice.PostTextOutput) + + PutSession(*lexruntimeservice.PutSessionInput) (*lexruntimeservice.PutSessionOutput, error) + PutSessionWithContext(aws.Context, *lexruntimeservice.PutSessionInput, ...request.Option) (*lexruntimeservice.PutSessionOutput, error) + PutSessionRequest(*lexruntimeservice.PutSessionInput) (*request.Request, *lexruntimeservice.PutSessionOutput) } var _ LexRuntimeServiceAPI = (*lexruntimeservice.LexRuntimeService)(nil) diff --git a/service/mediaconvert/api.go b/service/mediaconvert/api.go index 44ae4c49718..5d78d0c03f4 100644 --- a/service/mediaconvert/api.go +++ b/service/mediaconvert/api.go @@ -3190,9 +3190,10 @@ type AudioDescription struct { // Advanced audio remixing settings. RemixSettings *RemixSettings `locationName:"remixSettings" type:"structure"` - // Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by - // the player (eg. English, or Director Commentary). Alphanumeric characters, - // spaces, and underscore are legal. + // Specify a label for this output audio stream. For example, "English", "Director + // commentary", or "track_2". For streaming outputs, MediaConvert passes this + // information into destination manifests for display on the end-viewer's player + // device. For outputs in other output groups, the service ignores this setting. StreamName *string `locationName:"streamName" type:"string"` } @@ -3927,9 +3928,11 @@ type CaptionDescription struct { // the captions text. LanguageCode *string `locationName:"languageCode" type:"string" enum:"LanguageCode"` - // Human readable information to indicate captions available for players (eg. - // English, or Spanish). Alphanumeric characters, spaces, and underscore are - // legal. + // Specify a label for this set of output captions. For example, "English", + // "Director commentary", or "track_2". For streaming outputs, MediaConvert + // passes this information into destination manifests for display on the end-viewer's + // player device. For outputs in other output groups, the service ignores this + // setting. LanguageDescription *string `locationName:"languageDescription" type:"string"` } @@ -4017,9 +4020,11 @@ type CaptionDescriptionPreset struct { // the captions text. LanguageCode *string `locationName:"languageCode" type:"string" enum:"LanguageCode"` - // Human readable information to indicate captions available for players (eg. - // English, or Spanish). Alphanumeric characters, spaces, and underscore are - // legal. + // Specify a label for this set of output captions. For example, "English", + // "Director commentary", or "track_2". For streaming outputs, MediaConvert + // passes this information into destination manifests for display on the end-viewer's + // player device. For outputs in other output groups, the service ignores this + // setting. LanguageDescription *string `locationName:"languageDescription" type:"string"` } @@ -4420,19 +4425,23 @@ type CmafEncryptionSettings struct { // segment number by default. ConstantInitializationVector *string `locationName:"constantInitializationVector" min:"32" type:"string"` - // Encrypts the segments with the given encryption scheme. Leave blank to disable. - // Selecting 'Disabled' in the web interface also disables encryption. + // For DRM with CMAF, the encryption type is always sample AES. EncryptionMethod *string `locationName:"encryptionMethod" type:"string" enum:"CmafEncryptionType"` - // The Initialization Vector is a 128-bit number used in conjunction with the - // key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed - // in the manifest. Otherwise Initialization Vector is not in the manifest. + // When you use DRM with CMAF outputs, choose whether the service writes the + // 128-bit encryption initialization vector in the HLS and DASH manifests. InitializationVectorInManifest *string `locationName:"initializationVectorInManifest" type:"string" enum:"CmafInitializationVectorInManifest"` + // Use these settings when doing DRM encryption with a SPEKE-compliant key provider, + // if your output group type is CMAF. If your output group type is HLS, MS Smooth, + // or DASH, use the SpekeKeyProvider settings instead. + SpekeKeyProvider *SpekeKeyProviderCmaf `locationName:"spekeKeyProvider" type:"structure"` + // Use these settings to set up encryption with a static key provider. StaticKeyProvider *StaticKeyProvider `locationName:"staticKeyProvider" type:"structure"` - // Indicates which type of key provider is used for encryption. + // Specify whether your DRM encryption key is static or from a key provider + // that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html. Type *string `locationName:"type" type:"string" enum:"CmafKeyProviderType"` } @@ -4477,6 +4486,12 @@ func (s *CmafEncryptionSettings) SetInitializationVectorInManifest(v string) *Cm return s } +// SetSpekeKeyProvider sets the SpekeKeyProvider field's value. +func (s *CmafEncryptionSettings) SetSpekeKeyProvider(v *SpekeKeyProviderCmaf) *CmafEncryptionSettings { + s.SpekeKeyProvider = v + return s +} + // SetStaticKeyProvider sets the StaticKeyProvider field's value. func (s *CmafEncryptionSettings) SetStaticKeyProvider(v *StaticKeyProvider) *CmafEncryptionSettings { s.StaticKeyProvider = v @@ -4714,18 +4729,28 @@ type ColorCorrector struct { // Brightness level. Brightness *int64 `locationName:"brightness" min:"1" type:"integer"` - // Determines if colorspace conversion will be performed. If set to _None_, - // no conversion will be performed. If _Force 601_ or _Force 709_ are selected, - // conversion will be performed for inputs with differing colorspaces. An input's - // colorspace can be specified explicitly in the "Video Selector":#inputs-video_selector - // if necessary. + // Specify the color space you want for this output. The service supports conversion + // between HDR formats, between SDR formats, and from SDR to HDR. The service + // doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't + // upgrade the dynamic range. The converted video has an HDR format, but visually + // appears the same as an unconverted output. ColorSpaceConversion *string `locationName:"colorSpaceConversion" type:"string" enum:"ColorSpaceConversion"` // Contrast level. Contrast *int64 `locationName:"contrast" min:"1" type:"integer"` - // Use the HDR master display (Hdr10Metadata) settings to correct HDR metadata - // or to provide missing metadata. Note that these settings are not color correction. + // Use these settings when you convert to the HDR 10 color space. Specify the + // SMPTE ST 2086 Mastering Display Color Volume static metadata that you want + // signaled in the output. These values don't affect the pixel values that are + // encoded in the video stream. They are intended to help the downstream video + // player display content in a way that reflects the intentions of the the content + // creator. When you set Color space conversion (ColorSpaceConversion) to HDR + // 10 (FORCE_HDR10), these settings are required. You must set values for Max + // frame average light level (maxFrameAverageLightLevel) and Max content light + // level (maxContentLightLevel); these settings don't have a default value. + // The default values for the other HDR 10 metadata settings are defined by + // the P3D65 color space. For more information about MediaConvert HDR jobs, + // see https://docs.aws.amazon.com/console/mediaconvert/hdr. Hdr10Metadata *Hdr10Metadata `locationName:"hdr10Metadata" type:"structure"` // Hue in degrees. @@ -5395,6 +5420,10 @@ type CreateQueueInput struct { // queues and not applicable to on-demand queues. ReservationPlanSettings *ReservationPlanSettings `locationName:"reservationPlanSettings" type:"structure"` + // Initial state of the queue. If you create a paused queue, then jobs in that + // queue won't begin. + Status *string `locationName:"status" type:"string" enum:"QueueStatus"` + // The tags that you want to add to the resource. You can tag resources with // a key-value pair or with only a key. Tags map[string]*string `locationName:"tags" type:"map"` @@ -5452,6 +5481,12 @@ func (s *CreateQueueInput) SetReservationPlanSettings(v *ReservationPlanSettings return s } +// SetStatus sets the Status field's value. +func (s *CreateQueueInput) SetStatus(v string) *CreateQueueInput { + s.Status = &v + return s +} + // SetTags sets the Tags field's value. func (s *CreateQueueInput) SetTags(v map[string]*string) *CreateQueueInput { s.Tags = v @@ -5498,7 +5533,9 @@ type DashIsoEncryptionSettings struct { // the access unit delimiter and will leave the SEI NAL units unencrypted. PlaybackDeviceCompatibility *string `locationName:"playbackDeviceCompatibility" type:"string" enum:"DashIsoPlaybackDeviceCompatibility"` - // Settings for use with a SPEKE key provider + // Use these settings when doing DRM encryption with a SPEKE-compliant key provider, + // if your output group type is HLS, MS Smooth, or DASH. If your output group + // type is CMAF, use the SpekeKeyProviderCmaf settings instead. SpekeKeyProvider *SpekeKeyProvider `locationName:"spekeKeyProvider" type:"structure"` } @@ -6986,23 +7023,21 @@ func (s *Eac3Settings) SetSurroundMode(v string) *Eac3Settings { type EmbeddedDestinationSettings struct { _ struct{} `type:"structure"` - // Ignore this setting unless your input captions are SCC format. With SCC inputs, - // you can optionally use this setting to replace the input channel number with - // the channel number that you specify. Specify a different number for each - // output captions track for a particular output. If you don't specify an output - // channel number, the system uses the input channel number for the output channel - // number. You can optionally combine two captions channels in your output. - // The two output channel numbers can be one of the following pairs: 1,3; 2,4; - // 1,4; or 2,3. + // Ignore this setting unless your input captions are SCC format and your output + // captions are embedded in the video stream. Specify a CC number for each captions + // channel in this output. If you have two channels, pick CC numbers that aren't + // in the same field. For example, choose 1 and 3. For more information, see + // https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded. Destination608ChannelNumber *int64 `locationName:"destination608ChannelNumber" min:"1" type:"integer"` - // Ignore this setting unless your input captions are SCC format and you are - // performing SCC upconvert. With SCC inputs, you can optionally use this setting - // to specify the 708 service number that is in the output. Specify a different - // service number for each output captions track for a particular output. If - // you don't specify an output track number, the system uses the 608 channel - // number for the output 708 service number. You can combine two captions channels - // in your output. Service numbers must be distinct. + // Ignore this setting unless your input captions are SCC format and you want + // both 608 and 708 captions embedded in your output stream. Optionally, specify + // the 708 service number for each output captions channel. Choose a different + // number for each channel. To use this setting, also set Force 608 to 708 upconvert + // (Convert608To708) to Upconvert (UPCONVERT) in your input captions selector + // settings. If you choose to upconvert but don't specify a 708 service number, + // MediaConvert uses the number you specify for CC channel number (destination608ChannelNumber) + // for the 708 service number. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded. Destination708ServiceNumber *int64 `locationName:"destination708ServiceNumber" min:"1" type:"integer"` } @@ -7936,7 +7971,11 @@ type H264Settings struct { // Places a PPS header on each encoded picture, even if repeated. RepeatPps *string `locationName:"repeatPps" type:"string" enum:"H264RepeatPps"` - // Scene change detection (inserts I-frames on scene changes). + // Enable this setting to insert I-frames at scene changes that the service + // automatically detects. This improves video quality and is enabled by default. + // If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) + // for further video quality improvement. For more information about QVBR, see + // https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. SceneChangeDetect *string `locationName:"sceneChangeDetect" type:"string" enum:"H264SceneChangeDetect"` // Number of slices per picture. Must be less than or equal to the number of @@ -8402,17 +8441,18 @@ type H265Settings struct { // as 5000000. HrdBufferSize *int64 `locationName:"hrdBufferSize" type:"integer"` - // Use Interlace mode (InterlaceMode) to choose the scan line type for the output. - // * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce - // interlaced output with the entire output having the same field polarity (top - // or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default - // Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, - // behavior depends on the input scan type. - If the source is interlaced, the - // output will be interlaced with the same polarity as the source (it will follow - // the source). The output could therefore be a mix of "top field first" and - // "bottom field first". - If the source is progressive, the output will be - // interlaced with "top field first" or "bottom field first" polarity, depending - // on which of the Follow options you chose. + // Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) + // to create a progressive output, regardless of the scan type of your input. + // Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to + // create an output that's interlaced with the same field polarity throughout. + // Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) + // to create an interlaced output with the same field polarity as the source. + // If the source is interlaced, the output will be interlaced with the same + // polarity as the source (it will follow the source). The output could therefore + // be a mix of "top field first" and "bottom field first". If the source is + // progressive, your output will be interlaced with "top field first" or "bottom + // field first" polarity, depending on which of the Follow options you chose. + // If you don't choose a value, the service will default to Progressive (PROGRESSIVE). InterlaceMode *string `locationName:"interlaceMode" type:"string" enum:"H265InterlaceMode"` // Maximum bitrate in bits/second. For example, enter five megabits per second @@ -8465,7 +8505,11 @@ type H265Settings struct { // selects best strength based on content SampleAdaptiveOffsetFilterMode *string `locationName:"sampleAdaptiveOffsetFilterMode" type:"string" enum:"H265SampleAdaptiveOffsetFilterMode"` - // Scene change detection (inserts I-frames on scene changes). + // Enable this setting to insert I-frames at scene changes that the service + // automatically detects. This improves video quality and is enabled by default. + // If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) + // for further video quality improvement. For more information about QVBR, see + // https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. SceneChangeDetect *string `locationName:"sceneChangeDetect" type:"string" enum:"H265SceneChangeDetect"` // Number of slices per picture. Must be less than or equal to the number of @@ -8808,15 +8852,11 @@ func (s *H265Settings) SetWriteMp4PackagingType(v string) *H265Settings { return s } -// Use the "HDR master display information" (Hdr10Metadata) settings to correct -// HDR metadata or to provide missing metadata. These values vary depending -// on the input video and must be provided by a color grader. Range is 0 to -// 50,000; each increment represents 0.00002 in CIE1931 color coordinate. Note -// that these settings are not color correction. Note that if you are creating -// HDR outputs inside of an HLS CMAF package, to comply with the Apple specification, -// you must use the following settings. Set "MP4 packaging type" (writeMp4PackagingType) -// to HVC1 (HVC1). Set "Profile" (H265Settings > codecProfile) to Main10/High -// (MAIN10_HIGH). Set "Level" (H265Settings > codecLevel) to 5 (LEVEL_5). +// Use these settings to specify static color calibration metadata, as defined +// by SMPTE ST 2086. These values don't affect the pixel values that are encoded +// in the video stream. They are intended to help the downstream video player +// display content in a way that reflects the intentions of the the content +// creator. type Hdr10Metadata struct { _ struct{} `type:"structure"` @@ -8841,11 +8881,13 @@ type Hdr10Metadata struct { GreenPrimaryY *int64 `locationName:"greenPrimaryY" type:"integer"` // Maximum light level among all samples in the coded video sequence, in units - // of candelas per square meter. + // of candelas per square meter. This setting doesn't have a default value; + // you must specify a value that is suitable for the content. MaxContentLightLevel *int64 `locationName:"maxContentLightLevel" type:"integer"` // Maximum average light level of any frame in the coded video sequence, in - // units of candelas per square meter. + // units of candelas per square meter. This setting doesn't have a default value; + // you must specify a value that is suitable for the content. MaxFrameAverageLightLevel *int64 `locationName:"maxFrameAverageLightLevel" type:"integer"` // Nominal maximum mastering display luminance in units of of 0.0001 candelas @@ -9049,13 +9091,16 @@ type HlsEncryptionSettings struct { // playlist. This allows for offline Apple HLS FairPlay content protection. OfflineEncrypted *string `locationName:"offlineEncrypted" type:"string" enum:"HlsOfflineEncrypted"` - // Settings for use with a SPEKE key provider + // Use these settings when doing DRM encryption with a SPEKE-compliant key provider, + // if your output group type is HLS, MS Smooth, or DASH. If your output group + // type is CMAF, use the SpekeKeyProviderCmaf settings instead. SpekeKeyProvider *SpekeKeyProvider `locationName:"spekeKeyProvider" type:"structure"` // Use these settings to set up encryption with a static key provider. StaticKeyProvider *StaticKeyProvider `locationName:"staticKeyProvider" type:"structure"` - // Indicates which type of key provider is used for encryption. + // Specify whether your DRM encryption key is static or from a key provider + // that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html. Type *string `locationName:"type" type:"string" enum:"HlsKeyProviderType"` } @@ -12869,7 +12914,8 @@ type Mpeg2Settings struct { // is variable (vbr) or constant (cbr). RateControlMode *string `locationName:"rateControlMode" type:"string" enum:"Mpeg2RateControlMode"` - // Scene change detection (inserts I-frames on scene changes). + // Enable this setting to insert I-frames at scene changes that the service + // automatically detects. This improves video quality and is enabled by default. SceneChangeDetect *string `locationName:"sceneChangeDetect" type:"string" enum:"Mpeg2SceneChangeDetect"` // Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled @@ -13127,7 +13173,9 @@ func (s *Mpeg2Settings) SetTemporalAdaptiveQuantization(v string) *Mpeg2Settings type MsSmoothEncryptionSettings struct { _ struct{} `type:"structure"` - // Settings for use with a SPEKE key provider + // Use these settings when doing DRM encryption with a SPEKE-compliant key provider, + // if your output group type is HLS, MS Smooth, or DASH. If your output group + // type is CMAF, use the SpekeKeyProviderCmaf settings instead. SpekeKeyProvider *SpekeKeyProvider `locationName:"spekeKeyProvider" type:"structure"` } @@ -13290,10 +13338,11 @@ type NoiseReducer struct { // Use Noise reducer filter (NoiseReducerFilter) to select one of the following // spatial image filtering functions. To use this setting, you must also enable - // Noise reducer (NoiseReducer). * Bilateral is an edge preserving noise reduction - // filter. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) are convolution - // filters. * Conserve is a min/max noise reduction filter. * Spatial is a frequency-domain - // filter based on JND principles. + // Noise reducer (NoiseReducer). * Bilateral preserves edges while reducing + // noise. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) do convolution + // filtering. * Conserve does min/max noise reduction. * Spatial does frequency-domain + // filtering based on JND principles. * Temporal optimizes video quality for + // complex motion. Filter *string `locationName:"filter" type:"string" enum:"NoiseReducerFilter"` // Settings for a noise reducer filter @@ -13301,6 +13350,9 @@ type NoiseReducer struct { // Noise reducer filter settings for spatial filter. SpatialFilterSettings *NoiseReducerSpatialFilterSettings `locationName:"spatialFilterSettings" type:"structure"` + + // Noise reducer filter settings for temporal filter. + TemporalFilterSettings *NoiseReducerTemporalFilterSettings `locationName:"temporalFilterSettings" type:"structure"` } // String returns the string representation @@ -13321,6 +13373,11 @@ func (s *NoiseReducer) Validate() error { invalidParams.AddNested("SpatialFilterSettings", err.(request.ErrInvalidParams)) } } + if s.TemporalFilterSettings != nil { + if err := s.TemporalFilterSettings.Validate(); err != nil { + invalidParams.AddNested("TemporalFilterSettings", err.(request.ErrInvalidParams)) + } + } if invalidParams.Len() > 0 { return invalidParams @@ -13346,6 +13403,12 @@ func (s *NoiseReducer) SetSpatialFilterSettings(v *NoiseReducerSpatialFilterSett return s } +// SetTemporalFilterSettings sets the TemporalFilterSettings field's value. +func (s *NoiseReducer) SetTemporalFilterSettings(v *NoiseReducerTemporalFilterSettings) *NoiseReducer { + s.TemporalFilterSettings = v + return s +} + // Settings for a noise reducer filter type NoiseReducerFilterSettings struct { _ struct{} `type:"structure"` @@ -13429,6 +13492,68 @@ func (s *NoiseReducerSpatialFilterSettings) SetStrength(v int64) *NoiseReducerSp return s } +// Noise reducer filter settings for temporal filter. +type NoiseReducerTemporalFilterSettings struct { + _ struct{} `type:"structure"` + + // Use Aggressive mode for content that has complex motion. Higher values produce + // stronger temporal filtering. This filters highly complex scenes more aggressively + // and creates better VQ for low bitrate outputs. + AggressiveMode *int64 `locationName:"aggressiveMode" type:"integer"` + + // The speed of the filter (higher number is faster). Low setting reduces bit + // rate at the cost of transcode time, high setting improves transcode time + // at the cost of bit rate. + Speed *int64 `locationName:"speed" type:"integer"` + + // Relative strength of noise reducing filter. Higher values produce stronger + // filtering. Recommended Range: * [0 .. 2] for complexity reduction with minimal + // sharpness loss * [2 .. 8] for complexity reduction with image preservation + // * [8 .. 16] for noise reduction. Reduce noise combined high complexity reduction + Strength *int64 `locationName:"strength" type:"integer"` +} + +// String returns the string representation +func (s NoiseReducerTemporalFilterSettings) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s NoiseReducerTemporalFilterSettings) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *NoiseReducerTemporalFilterSettings) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "NoiseReducerTemporalFilterSettings"} + if s.Speed != nil && *s.Speed < -1 { + invalidParams.Add(request.NewErrParamMinValue("Speed", -1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAggressiveMode sets the AggressiveMode field's value. +func (s *NoiseReducerTemporalFilterSettings) SetAggressiveMode(v int64) *NoiseReducerTemporalFilterSettings { + s.AggressiveMode = &v + return s +} + +// SetSpeed sets the Speed field's value. +func (s *NoiseReducerTemporalFilterSettings) SetSpeed(v int64) *NoiseReducerTemporalFilterSettings { + s.Speed = &v + return s +} + +// SetStrength sets the Strength field's value. +func (s *NoiseReducerTemporalFilterSettings) SetStrength(v int64) *NoiseReducerTemporalFilterSettings { + s.Strength = &v + return s +} + // An output object describes the settings for a single output file or stream // in an output group. type Output struct { @@ -14786,24 +14911,28 @@ func (s *SccDestinationSettings) SetFramerate(v string) *SccDestinationSettings return s } -// Settings for use with a SPEKE key provider +// Use these settings when doing DRM encryption with a SPEKE-compliant key provider, +// if your output group type is HLS, MS Smooth, or DASH. If your output group +// type is CMAF, use the SpekeKeyProviderCmaf settings instead. type SpekeKeyProvider struct { _ struct{} `type:"structure"` - // Optional AWS Certificate Manager ARN for a certificate to send to the keyprovider. - // The certificate holds a key used by the keyprovider to encrypt the keys in - // its response. + // If you want your key provider to encrypt the content keys that it provides + // to MediaConvert, set up a certificate with a master key using AWS Certificate + // Manager. Specify the certificate's Amazon Resource Name (ARN) here. CertificateArn *string `locationName:"certificateArn" type:"string"` - // The SPEKE-compliant server uses Resource ID (ResourceId) to identify content. + // Specify the resource ID that your SPEKE-compliant key provider uses to identify + // this content. ResourceId *string `locationName:"resourceId" type:"string"` // Relates to SPEKE implementation. DRM system identifiers. DASH output groups // support a max of two system ids. Other group types support one system id. + // See https://dashif.org/identifiers/content_protection/ for more details. SystemIds []*string `locationName:"systemIds" type:"list"` - // Use URL (Url) to specify the SPEKE-compliant server that will provide keys - // for content. + // Specify the URL to the key server that your SPEKE-compliant DRM key provider + // uses to provide keys for encrypting your content. Url *string `locationName:"url" type:"string"` } @@ -14841,6 +14970,76 @@ func (s *SpekeKeyProvider) SetUrl(v string) *SpekeKeyProvider { return s } +// Use these settings when doing DRM encryption with a SPEKE-compliant key provider, +// if your output group type is CMAF. If your output group type is HLS, MS Smooth, +// or DASH, use the SpekeKeyProvider settings instead. +type SpekeKeyProviderCmaf struct { + _ struct{} `type:"structure"` + + // If you want your key provider to encrypt the content keys that it provides + // to MediaConvert, set up a certificate with a master key using AWS Certificate + // Manager. Specify the certificate's Amazon Resource Name (ARN) here. + CertificateArn *string `locationName:"certificateArn" type:"string"` + + // Specify the DRM system IDs that you want signaled in the DASH manifest that + // MediaConvert creates as part of this CMAF package. The DASH manifest can + // currently signal up to three system IDs. For more information, see https://dashif.org/identifiers/content_protection/. + DashSignaledSystemIds []*string `locationName:"dashSignaledSystemIds" type:"list"` + + // Specify the DRM system ID that you want signaled in the HLS manifest that + // MediaConvert creates as part of this CMAF package. The HLS manifest can currently + // signal only one system ID. For more information, see https://dashif.org/identifiers/content_protection/. + HlsSignaledSystemIds []*string `locationName:"hlsSignaledSystemIds" type:"list"` + + // Specify the resource ID that your SPEKE-compliant key provider uses to identify + // this content. + ResourceId *string `locationName:"resourceId" type:"string"` + + // Specify the URL to the key server that your SPEKE-compliant DRM key provider + // uses to provide keys for encrypting your content. + Url *string `locationName:"url" type:"string"` +} + +// String returns the string representation +func (s SpekeKeyProviderCmaf) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s SpekeKeyProviderCmaf) GoString() string { + return s.String() +} + +// SetCertificateArn sets the CertificateArn field's value. +func (s *SpekeKeyProviderCmaf) SetCertificateArn(v string) *SpekeKeyProviderCmaf { + s.CertificateArn = &v + return s +} + +// SetDashSignaledSystemIds sets the DashSignaledSystemIds field's value. +func (s *SpekeKeyProviderCmaf) SetDashSignaledSystemIds(v []*string) *SpekeKeyProviderCmaf { + s.DashSignaledSystemIds = v + return s +} + +// SetHlsSignaledSystemIds sets the HlsSignaledSystemIds field's value. +func (s *SpekeKeyProviderCmaf) SetHlsSignaledSystemIds(v []*string) *SpekeKeyProviderCmaf { + s.HlsSignaledSystemIds = v + return s +} + +// SetResourceId sets the ResourceId field's value. +func (s *SpekeKeyProviderCmaf) SetResourceId(v string) *SpekeKeyProviderCmaf { + s.ResourceId = &v + return s +} + +// SetUrl sets the Url field's value. +func (s *SpekeKeyProviderCmaf) SetUrl(v string) *SpekeKeyProviderCmaf { + s.Url = &v + return s +} + // Use these settings to set up encryption with a static key provider. type StaticKeyProvider struct { _ struct{} `type:"structure"` @@ -14978,6 +15177,13 @@ type TeletextDestinationSettings struct { // ending in -FF are invalid. If you are passing through the entire set of Teletext // data, do not use this field. PageNumber *string `locationName:"pageNumber" min:"3" type:"string"` + + // Specify the page types for this Teletext page. If you don't specify a value + // here, the service sets the page type to the default value Subtitle (PAGE_TYPE_SUBTITLE). + // If you pass through the entire set of Teletext data, don't use this field. + // When you pass through a set of Teletext pages, your output has the same page + // types as your input. + PageTypes []*string `locationName:"pageTypes" type:"list"` } // String returns the string representation @@ -15009,6 +15215,12 @@ func (s *TeletextDestinationSettings) SetPageNumber(v string) *TeletextDestinati return s } +// SetPageTypes sets the PageTypes field's value. +func (s *TeletextDestinationSettings) SetPageTypes(v []*string) *TeletextDestinationSettings { + s.PageTypes = v + return s +} + // Settings specific to Teletext caption sources, including Page number. type TeletextSourceSettings struct { _ struct{} `type:"structure"` @@ -15906,8 +16118,9 @@ type VideoDescription struct { // FrameCaptureSettings CodecSettings *VideoCodecSettings `locationName:"codecSettings" type:"structure"` - // Enable Insert color metadata (ColorMetadata) to include color metadata in - // this output. This setting is enabled by default. + // Choose Insert (INSERT) for this setting to include color metadata in this + // output. Choose Ignore (IGNORE) to exclude color metadata from this output. + // If you don't specify a value, the service sets this to Insert by default. ColorMetadata *string `locationName:"colorMetadata" type:"string" enum:"ColorMetadata"` // Use Cropping selection (crop) to specify the video area that the service @@ -16258,33 +16471,37 @@ type VideoSelector struct { _ struct{} `type:"structure"` // If your input video has accurate color space metadata, or if you don't know - // about color space, leave this set to the default value FOLLOW. The service - // will automatically detect your input color space. If your input video has - // metadata indicating the wrong color space, or if your input video is missing - // color space metadata that should be there, specify the accurate color space - // here. If you choose HDR10, you can also correct inaccurate color space coefficients, - // using the HDR master display information controls. You must also set Color - // space usage (ColorSpaceUsage) to FORCE for the service to use these values. + // about color space, leave this set to the default value Follow (FOLLOW). The + // service will automatically detect your input color space. If your input video + // has metadata indicating the wrong color space, specify the accurate color + // space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering + // Display Color Volume static metadata isn't present in your video stream, + // or if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) + // here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) + // settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr. ColorSpace *string `locationName:"colorSpace" type:"string" enum:"ColorSpace"` - // There are two sources for color metadata, the input file and the job configuration - // (in the Color space and HDR master display informaiton settings). The Color - // space usage setting controls which takes precedence. FORCE: The system will - // use color metadata supplied by user, if any. If the user does not supply - // color metadata, the system will use data from the source. FALLBACK: The system - // will use color metadata from the source. If source has no color metadata, - // the system will use user-supplied color metadata values if available. + // There are two sources for color metadata, the input file and the job input + // settings Color space (ColorSpace) and HDR master display information settings(Hdr10Metadata). + // The Color space usage setting determines which takes precedence. Choose Force + // (FORCE) to use color metadata from the input job settings. If you don't specify + // values for those settings, the service defaults to using metadata from your + // input. FALLBACK - Choose Fallback (FALLBACK) to use color metadata from the + // source when it is present. If there's no color metadata in your input file, + // the service defaults to using values you specify in the input settings. ColorSpaceUsage *string `locationName:"colorSpaceUsage" type:"string" enum:"ColorSpaceUsage"` - // Use the "HDR master display information" (Hdr10Metadata) settings to correct - // HDR metadata or to provide missing metadata. These values vary depending - // on the input video and must be provided by a color grader. Range is 0 to - // 50,000; each increment represents 0.00002 in CIE1931 color coordinate. Note - // that these settings are not color correction. Note that if you are creating - // HDR outputs inside of an HLS CMAF package, to comply with the Apple specification, - // you must use the following settings. Set "MP4 packaging type" (writeMp4PackagingType) - // to HVC1 (HVC1). Set "Profile" (H265Settings > codecProfile) to Main10/High - // (MAIN10_HIGH). Set "Level" (H265Settings > codecLevel) to 5 (LEVEL_5). + // Use these settings to provide HDR 10 metadata that is missing or inaccurate + // in your input video. Appropriate values vary depending on the input video + // and must be provided by a color grader. The color grader generates these + // values during the HDR 10 mastering process. The valid range for each of these + // settings is 0 to 50,000. Each increment represents 0.00002 in CIE1931 color + // coordinate. Related settings - When you specify these values, you must also + // set Color space (ColorSpace) to HDR 10 (HDR10). To specify whether the the + // values you specify here take precedence over the values in the metadata of + // your input file, set Color space usage (ColorSpaceUsage). To specify whether + // color metadata is included in an output, set Color metadata (ColorMetadata). + // For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr. Hdr10Metadata *Hdr10Metadata `locationName:"hdr10Metadata" type:"structure"` // Use PID (Pid) to select specific video data from an input file. Specify this @@ -17004,16 +17221,14 @@ const ( CmafCodecSpecificationRfc4281 = "RFC_4281" ) -// Encrypts the segments with the given encryption scheme. Leave blank to disable. -// Selecting 'Disabled' in the web interface also disables encryption. +// For DRM with CMAF, the encryption type is always sample AES. const ( // CmafEncryptionTypeSampleAes is a CmafEncryptionType enum value CmafEncryptionTypeSampleAes = "SAMPLE_AES" ) -// The Initialization Vector is a 128-bit number used in conjunction with the -// key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed -// in the manifest. Otherwise Initialization Vector is not in the manifest. +// When you use DRM with CMAF outputs, choose whether the service writes the +// 128-bit encryption initialization vector in the HLS and DASH manifests. const ( // CmafInitializationVectorInManifestInclude is a CmafInitializationVectorInManifest enum value CmafInitializationVectorInManifestInclude = "INCLUDE" @@ -17022,8 +17237,12 @@ const ( CmafInitializationVectorInManifestExclude = "EXCLUDE" ) -// Indicates which type of key provider is used for encryption. +// Specify whether your DRM encryption key is static or from a key provider +// that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html. const ( + // CmafKeyProviderTypeSpeke is a CmafKeyProviderType enum value + CmafKeyProviderTypeSpeke = "SPEKE" + // CmafKeyProviderTypeStaticKey is a CmafKeyProviderType enum value CmafKeyProviderTypeStaticKey = "STATIC_KEY" ) @@ -17086,8 +17305,9 @@ const ( CmafWriteHLSManifestEnabled = "ENABLED" ) -// Enable Insert color metadata (ColorMetadata) to include color metadata in -// this output. This setting is enabled by default. +// Choose Insert (INSERT) for this setting to include color metadata in this +// output. Choose Ignore (IGNORE) to exclude color metadata from this output. +// If you don't specify a value, the service sets this to Insert by default. const ( // ColorMetadataIgnore is a ColorMetadata enum value ColorMetadataIgnore = "IGNORE" @@ -17097,13 +17317,14 @@ const ( ) // If your input video has accurate color space metadata, or if you don't know -// about color space, leave this set to the default value FOLLOW. The service -// will automatically detect your input color space. If your input video has -// metadata indicating the wrong color space, or if your input video is missing -// color space metadata that should be there, specify the accurate color space -// here. If you choose HDR10, you can also correct inaccurate color space coefficients, -// using the HDR master display information controls. You must also set Color -// space usage (ColorSpaceUsage) to FORCE for the service to use these values. +// about color space, leave this set to the default value Follow (FOLLOW). The +// service will automatically detect your input color space. If your input video +// has metadata indicating the wrong color space, specify the accurate color +// space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering +// Display Color Volume static metadata isn't present in your video stream, +// or if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) +// here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) +// settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr. const ( // ColorSpaceFollow is a ColorSpace enum value ColorSpaceFollow = "FOLLOW" @@ -17121,11 +17342,11 @@ const ( ColorSpaceHlg2020 = "HLG_2020" ) -// Determines if colorspace conversion will be performed. If set to _None_, -// no conversion will be performed. If _Force 601_ or _Force 709_ are selected, -// conversion will be performed for inputs with differing colorspaces. An input's -// colorspace can be specified explicitly in the "Video Selector":#inputs-video_selector -// if necessary. +// Specify the color space you want for this output. The service supports conversion +// between HDR formats, between SDR formats, and from SDR to HDR. The service +// doesn't support conversion from HDR to SDR. SDR to HDR conversion doesn't +// upgrade the dynamic range. The converted video has an HDR format, but visually +// appears the same as an unconverted output. const ( // ColorSpaceConversionNone is a ColorSpaceConversion enum value ColorSpaceConversionNone = "NONE" @@ -17143,13 +17364,14 @@ const ( ColorSpaceConversionForceHlg2020 = "FORCE_HLG_2020" ) -// There are two sources for color metadata, the input file and the job configuration -// (in the Color space and HDR master display informaiton settings). The Color -// space usage setting controls which takes precedence. FORCE: The system will -// use color metadata supplied by user, if any. If the user does not supply -// color metadata, the system will use data from the source. FALLBACK: The system -// will use color metadata from the source. If source has no color metadata, -// the system will use user-supplied color metadata values if available. +// There are two sources for color metadata, the input file and the job input +// settings Color space (ColorSpace) and HDR master display information settings(Hdr10Metadata). +// The Color space usage setting determines which takes precedence. Choose Force +// (FORCE) to use color metadata from the input job settings. If you don't specify +// values for those settings, the service defaults to using metadata from your +// input. FALLBACK - Choose Fallback (FALLBACK) to use color metadata from the +// source when it is present. If there's no color metadata in your input file, +// the service defaults to using values you specify in the input settings. const ( // ColorSpaceUsageForce is a ColorSpaceUsage enum value ColorSpaceUsageForce = "FORCE" @@ -18046,13 +18268,20 @@ const ( H264RepeatPpsEnabled = "ENABLED" ) -// Scene change detection (inserts I-frames on scene changes). +// Enable this setting to insert I-frames at scene changes that the service +// automatically detects. This improves video quality and is enabled by default. +// If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) +// for further video quality improvement. For more information about QVBR, see +// https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. const ( // H264SceneChangeDetectDisabled is a H264SceneChangeDetect enum value H264SceneChangeDetectDisabled = "DISABLED" // H264SceneChangeDetectEnabled is a H264SceneChangeDetect enum value H264SceneChangeDetectEnabled = "ENABLED" + + // H264SceneChangeDetectTransitionDetection is a H264SceneChangeDetect enum value + H264SceneChangeDetectTransitionDetection = "TRANSITION_DETECTION" ) // Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled @@ -18297,17 +18526,18 @@ const ( H265GopSizeUnitsSeconds = "SECONDS" ) -// Use Interlace mode (InterlaceMode) to choose the scan line type for the output. -// * Top Field First (TOP_FIELD) and Bottom Field First (BOTTOM_FIELD) produce -// interlaced output with the entire output having the same field polarity (top -// or bottom first). * Follow, Default Top (FOLLOW_TOP_FIELD) and Follow, Default -// Bottom (FOLLOW_BOTTOM_FIELD) use the same field polarity as the source. Therefore, -// behavior depends on the input scan type. - If the source is interlaced, the -// output will be interlaced with the same polarity as the source (it will follow -// the source). The output could therefore be a mix of "top field first" and -// "bottom field first". - If the source is progressive, the output will be -// interlaced with "top field first" or "bottom field first" polarity, depending -// on which of the Follow options you chose. +// Choose the scan line type for the output. Choose Progressive (PROGRESSIVE) +// to create a progressive output, regardless of the scan type of your input. +// Choose Top Field First (TOP_FIELD) or Bottom Field First (BOTTOM_FIELD) to +// create an output that's interlaced with the same field polarity throughout. +// Choose Follow, Default Top (FOLLOW_TOP_FIELD) or Follow, Default Bottom (FOLLOW_BOTTOM_FIELD) +// to create an interlaced output with the same field polarity as the source. +// If the source is interlaced, the output will be interlaced with the same +// polarity as the source (it will follow the source). The output could therefore +// be a mix of "top field first" and "bottom field first". If the source is +// progressive, your output will be interlaced with "top field first" or "bottom +// field first" polarity, depending on which of the Follow options you chose. +// If you don't choose a value, the service will default to Progressive (PROGRESSIVE). const ( // H265InterlaceModeProgressive is a H265InterlaceMode enum value H265InterlaceModeProgressive = "PROGRESSIVE" @@ -18376,13 +18606,20 @@ const ( H265SampleAdaptiveOffsetFilterModeOff = "OFF" ) -// Scene change detection (inserts I-frames on scene changes). +// Enable this setting to insert I-frames at scene changes that the service +// automatically detects. This improves video quality and is enabled by default. +// If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) +// for further video quality improvement. For more information about QVBR, see +// https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr. const ( // H265SceneChangeDetectDisabled is a H265SceneChangeDetect enum value H265SceneChangeDetectDisabled = "DISABLED" // H265SceneChangeDetectEnabled is a H265SceneChangeDetect enum value H265SceneChangeDetectEnabled = "ENABLED" + + // H265SceneChangeDetectTransitionDetection is a H265SceneChangeDetect enum value + H265SceneChangeDetectTransitionDetection = "TRANSITION_DETECTION" ) // Enables Slow PAL rate conversion. 23.976fps and 24fps input is relabeled @@ -18613,7 +18850,8 @@ const ( HlsInitializationVectorInManifestExclude = "EXCLUDE" ) -// Indicates which type of key provider is used for encryption. +// Specify whether your DRM encryption key is static or from a key provider +// that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html. const ( // HlsKeyProviderTypeSpeke is a HlsKeyProviderType enum value HlsKeyProviderTypeSpeke = "SPEKE" @@ -19893,7 +20131,8 @@ const ( Mpeg2RateControlModeCbr = "CBR" ) -// Scene change detection (inserts I-frames on scene changes). +// Enable this setting to insert I-frames at scene changes that the service +// automatically detects. This improves video quality and is enabled by default. const ( // Mpeg2SceneChangeDetectDisabled is a Mpeg2SceneChangeDetect enum value Mpeg2SceneChangeDetectDisabled = "DISABLED" @@ -19978,10 +20217,11 @@ const ( // Use Noise reducer filter (NoiseReducerFilter) to select one of the following // spatial image filtering functions. To use this setting, you must also enable -// Noise reducer (NoiseReducer). * Bilateral is an edge preserving noise reduction -// filter. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) are convolution -// filters. * Conserve is a min/max noise reduction filter. * Spatial is a frequency-domain -// filter based on JND principles. +// Noise reducer (NoiseReducer). * Bilateral preserves edges while reducing +// noise. * Mean (softest), Gaussian, Lanczos, and Sharpen (sharpest) do convolution +// filtering. * Conserve does min/max noise reduction. * Spatial does frequency-domain +// filtering based on JND principles. * Temporal optimizes video quality for +// complex motion. const ( // NoiseReducerFilterBilateral is a NoiseReducerFilter enum value NoiseReducerFilterBilateral = "BILATERAL" @@ -20003,6 +20243,9 @@ const ( // NoiseReducerFilterSpatial is a NoiseReducerFilter enum value NoiseReducerFilterSpatial = "SPATIAL" + + // NoiseReducerFilterTemporal is a NoiseReducerFilter enum value + NoiseReducerFilterTemporal = "TEMPORAL" ) // When you request lists of resources, you can optionally specify whether they @@ -20352,6 +20595,24 @@ const ( StatusUpdateIntervalSeconds600 = "SECONDS_600" ) +// A page type as defined in the standard ETSI EN 300 468, Table 94 +const ( + // TeletextPageTypePageTypeInitial is a TeletextPageType enum value + TeletextPageTypePageTypeInitial = "PAGE_TYPE_INITIAL" + + // TeletextPageTypePageTypeSubtitle is a TeletextPageType enum value + TeletextPageTypePageTypeSubtitle = "PAGE_TYPE_SUBTITLE" + + // TeletextPageTypePageTypeAddlInfo is a TeletextPageType enum value + TeletextPageTypePageTypeAddlInfo = "PAGE_TYPE_ADDL_INFO" + + // TeletextPageTypePageTypeProgramSchedule is a TeletextPageType enum value + TeletextPageTypePageTypeProgramSchedule = "PAGE_TYPE_PROGRAM_SCHEDULE" + + // TeletextPageTypePageTypeHearingImpairedSubtitle is a TeletextPageType enum value + TeletextPageTypePageTypeHearingImpairedSubtitle = "PAGE_TYPE_HEARING_IMPAIRED_SUBTITLE" +) + // Use Position (Position) under under Timecode burn-in (TimecodeBurnIn) to // specify the location the burned-in timecode on output video. const ( diff --git a/service/redshift/api.go b/service/redshift/api.go index f728da8cab6..957dde81ba8 100644 --- a/service/redshift/api.go +++ b/service/redshift/api.go @@ -5739,8 +5739,7 @@ func (c *Redshift) DescribeStorageRequest(input *DescribeStorageInput) (req *req // DescribeStorage API operation for Amazon Redshift. // -// Returns the total amount of snapshot usage and provisioned storage for a -// user in megabytes. +// Returns the total amount of snapshot usage and provisioned storage in megabytes. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -9485,6 +9484,18 @@ type Cluster struct { // Default: false EnhancedVpcRouting *bool `type:"boolean"` + // The date and time when the next snapshot is expected to be taken for clusters + // with a valid snapshot schedule and backups enabled. + ExpectedNextSnapshotScheduleTime *time.Time `type:"timestamp"` + + // The status of next expected snapshot for clusters having a valid snapshot + // schedule and backups enabled. Possible values are the following: + // + // * OnTrack - The next snapshot is expected to be taken on time. + // + // * Pending - The next snapshot is pending to be taken. + ExpectedNextSnapshotScheduleTimeStatus *string `type:"string"` + // A value that reports whether the Amazon Redshift cluster has finished applying // any hardware security module (HSM) settings changes specified in a modify // cluster command. @@ -9716,6 +9727,18 @@ func (s *Cluster) SetEnhancedVpcRouting(v bool) *Cluster { return s } +// SetExpectedNextSnapshotScheduleTime sets the ExpectedNextSnapshotScheduleTime field's value. +func (s *Cluster) SetExpectedNextSnapshotScheduleTime(v time.Time) *Cluster { + s.ExpectedNextSnapshotScheduleTime = &v + return s +} + +// SetExpectedNextSnapshotScheduleTimeStatus sets the ExpectedNextSnapshotScheduleTimeStatus field's value. +func (s *Cluster) SetExpectedNextSnapshotScheduleTimeStatus(v string) *Cluster { + s.ExpectedNextSnapshotScheduleTimeStatus = &v + return s +} + // SetHsmStatus sets the HsmStatus field's value. func (s *Cluster) SetHsmStatus(v *HsmStatus) *Cluster { s.HsmStatus = v @@ -19502,7 +19525,8 @@ type ResizeClusterInput struct { // The new cluster type for the specified cluster. ClusterType *string `type:"string"` - // The new node type for the nodes you are adding. + // The new node type for the nodes you are adding. If not specified, the cluster's + // current node type is used. NodeType *string `type:"string"` // The new number of nodes for the cluster.