aws-sdk
Version:
AWS SDK for JavaScript
2,006 lines (2,005 loc) • 83.9 kB
JSON
{
"version": "2.0",
"metadata": {
"apiVersion": "2022-03-31",
"auth": [
"aws.auth#sigv4"
],
"endpointPrefix": "sms-voice",
"jsonVersion": "1.0",
"protocol": "json",
"protocols": [
"json"
],
"serviceFullName": "Amazon Pinpoint SMS Voice V2",
"serviceId": "Pinpoint SMS Voice V2",
"signatureVersion": "v4",
"signingName": "sms-voice",
"targetPrefix": "PinpointSMSVoiceV2",
"uid": "pinpoint-sms-voice-v2-2022-03-31"
},
"operations": {
"AssociateOriginationIdentity": {
"input": {
"type": "structure",
"required": [
"PoolId",
"OriginationIdentity",
"IsoCountryCode"
],
"members": {
"PoolId": {},
"OriginationIdentity": {},
"IsoCountryCode": {},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"members": {
"PoolArn": {},
"PoolId": {},
"OriginationIdentityArn": {},
"OriginationIdentity": {},
"IsoCountryCode": {}
}
}
},
"AssociateProtectConfiguration": {
"input": {
"type": "structure",
"required": [
"ProtectConfigurationId",
"ConfigurationSetName"
],
"members": {
"ProtectConfigurationId": {},
"ConfigurationSetName": {}
}
},
"output": {
"type": "structure",
"required": [
"ConfigurationSetArn",
"ConfigurationSetName",
"ProtectConfigurationArn",
"ProtectConfigurationId"
],
"members": {
"ConfigurationSetArn": {},
"ConfigurationSetName": {},
"ProtectConfigurationArn": {},
"ProtectConfigurationId": {}
}
}
},
"CreateConfigurationSet": {
"input": {
"type": "structure",
"required": [
"ConfigurationSetName"
],
"members": {
"ConfigurationSetName": {},
"Tags": {
"shape": "Sg"
},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"members": {
"ConfigurationSetArn": {},
"ConfigurationSetName": {},
"Tags": {
"shape": "Sg"
},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"CreateEventDestination": {
"input": {
"type": "structure",
"required": [
"ConfigurationSetName",
"EventDestinationName",
"MatchingEventTypes"
],
"members": {
"ConfigurationSetName": {},
"EventDestinationName": {},
"MatchingEventTypes": {
"shape": "So"
},
"CloudWatchLogsDestination": {
"shape": "Sq"
},
"KinesisFirehoseDestination": {
"shape": "St"
},
"SnsDestination": {
"shape": "Sv"
},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"members": {
"ConfigurationSetArn": {},
"ConfigurationSetName": {},
"EventDestination": {
"shape": "Sy"
}
}
}
},
"CreateOptOutList": {
"input": {
"type": "structure",
"required": [
"OptOutListName"
],
"members": {
"OptOutListName": {},
"Tags": {
"shape": "Sg"
},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"members": {
"OptOutListArn": {},
"OptOutListName": {},
"Tags": {
"shape": "Sg"
},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"CreatePool": {
"input": {
"type": "structure",
"required": [
"OriginationIdentity",
"IsoCountryCode",
"MessageType"
],
"members": {
"OriginationIdentity": {},
"IsoCountryCode": {},
"MessageType": {},
"DeletionProtectionEnabled": {
"type": "boolean"
},
"Tags": {
"shape": "Sg"
},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"members": {
"PoolArn": {},
"PoolId": {},
"Status": {},
"MessageType": {},
"TwoWayEnabled": {
"type": "boolean"
},
"TwoWayChannelArn": {},
"TwoWayChannelRole": {},
"SelfManagedOptOutsEnabled": {
"type": "boolean"
},
"OptOutListName": {},
"SharedRoutesEnabled": {
"type": "boolean"
},
"DeletionProtectionEnabled": {
"type": "boolean"
},
"Tags": {
"shape": "Sg"
},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"CreateProtectConfiguration": {
"input": {
"type": "structure",
"members": {
"ClientToken": {
"idempotencyToken": true
},
"DeletionProtectionEnabled": {
"type": "boolean"
},
"Tags": {
"shape": "Sg"
}
}
},
"output": {
"type": "structure",
"required": [
"ProtectConfigurationArn",
"ProtectConfigurationId",
"CreatedTimestamp",
"AccountDefault",
"DeletionProtectionEnabled"
],
"members": {
"ProtectConfigurationArn": {},
"ProtectConfigurationId": {},
"CreatedTimestamp": {
"type": "timestamp"
},
"AccountDefault": {
"type": "boolean"
},
"DeletionProtectionEnabled": {
"type": "boolean"
},
"Tags": {
"shape": "Sg"
}
}
}
},
"CreateRegistration": {
"input": {
"type": "structure",
"required": [
"RegistrationType"
],
"members": {
"RegistrationType": {},
"Tags": {
"shape": "Sg"
},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationArn",
"RegistrationId",
"RegistrationType",
"RegistrationStatus",
"CurrentVersionNumber",
"CreatedTimestamp"
],
"members": {
"RegistrationArn": {},
"RegistrationId": {},
"RegistrationType": {},
"RegistrationStatus": {},
"CurrentVersionNumber": {
"type": "long"
},
"AdditionalAttributes": {
"shape": "S1g"
},
"Tags": {
"shape": "Sg"
},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"CreateRegistrationAssociation": {
"input": {
"type": "structure",
"required": [
"RegistrationId",
"ResourceId"
],
"members": {
"RegistrationId": {},
"ResourceId": {}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationArn",
"RegistrationId",
"RegistrationType",
"ResourceArn",
"ResourceId",
"ResourceType"
],
"members": {
"RegistrationArn": {},
"RegistrationId": {},
"RegistrationType": {},
"ResourceArn": {},
"ResourceId": {},
"ResourceType": {},
"IsoCountryCode": {},
"PhoneNumber": {}
}
}
},
"CreateRegistrationAttachment": {
"input": {
"type": "structure",
"members": {
"AttachmentBody": {
"type": "blob"
},
"AttachmentUrl": {},
"Tags": {
"shape": "Sg"
},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationAttachmentArn",
"RegistrationAttachmentId",
"AttachmentStatus",
"CreatedTimestamp"
],
"members": {
"RegistrationAttachmentArn": {},
"RegistrationAttachmentId": {},
"AttachmentStatus": {},
"Tags": {
"shape": "Sg"
},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"CreateRegistrationVersion": {
"input": {
"type": "structure",
"required": [
"RegistrationId"
],
"members": {
"RegistrationId": {}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationArn",
"RegistrationId",
"VersionNumber",
"RegistrationVersionStatus",
"RegistrationVersionStatusHistory"
],
"members": {
"RegistrationArn": {},
"RegistrationId": {},
"VersionNumber": {
"type": "long"
},
"RegistrationVersionStatus": {},
"RegistrationVersionStatusHistory": {
"shape": "S1u"
}
}
}
},
"CreateVerifiedDestinationNumber": {
"input": {
"type": "structure",
"required": [
"DestinationPhoneNumber"
],
"members": {
"DestinationPhoneNumber": {},
"Tags": {
"shape": "Sg"
},
"ClientToken": {
"idempotencyToken": true
}
}
},
"output": {
"type": "structure",
"required": [
"VerifiedDestinationNumberArn",
"VerifiedDestinationNumberId",
"DestinationPhoneNumber",
"Status",
"CreatedTimestamp"
],
"members": {
"VerifiedDestinationNumberArn": {},
"VerifiedDestinationNumberId": {},
"DestinationPhoneNumber": {},
"Status": {},
"Tags": {
"shape": "Sg"
},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"DeleteAccountDefaultProtectConfiguration": {
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"required": [
"DefaultProtectConfigurationArn",
"DefaultProtectConfigurationId"
],
"members": {
"DefaultProtectConfigurationArn": {},
"DefaultProtectConfigurationId": {}
}
}
},
"DeleteConfigurationSet": {
"input": {
"type": "structure",
"required": [
"ConfigurationSetName"
],
"members": {
"ConfigurationSetName": {}
}
},
"output": {
"type": "structure",
"members": {
"ConfigurationSetArn": {},
"ConfigurationSetName": {},
"EventDestinations": {
"shape": "S22"
},
"DefaultMessageType": {},
"DefaultSenderId": {},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"DeleteDefaultMessageType": {
"input": {
"type": "structure",
"required": [
"ConfigurationSetName"
],
"members": {
"ConfigurationSetName": {}
}
},
"output": {
"type": "structure",
"members": {
"ConfigurationSetArn": {},
"ConfigurationSetName": {},
"MessageType": {}
}
}
},
"DeleteDefaultSenderId": {
"input": {
"type": "structure",
"required": [
"ConfigurationSetName"
],
"members": {
"ConfigurationSetName": {}
}
},
"output": {
"type": "structure",
"members": {
"ConfigurationSetArn": {},
"ConfigurationSetName": {},
"SenderId": {}
}
}
},
"DeleteEventDestination": {
"input": {
"type": "structure",
"required": [
"ConfigurationSetName",
"EventDestinationName"
],
"members": {
"ConfigurationSetName": {},
"EventDestinationName": {}
}
},
"output": {
"type": "structure",
"members": {
"ConfigurationSetArn": {},
"ConfigurationSetName": {},
"EventDestination": {
"shape": "Sy"
}
}
}
},
"DeleteKeyword": {
"input": {
"type": "structure",
"required": [
"OriginationIdentity",
"Keyword"
],
"members": {
"OriginationIdentity": {},
"Keyword": {}
}
},
"output": {
"type": "structure",
"members": {
"OriginationIdentityArn": {},
"OriginationIdentity": {},
"Keyword": {},
"KeywordMessage": {},
"KeywordAction": {}
}
}
},
"DeleteMediaMessageSpendLimitOverride": {
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"members": {
"MonthlyLimit": {
"type": "long"
}
}
}
},
"DeleteOptOutList": {
"input": {
"type": "structure",
"required": [
"OptOutListName"
],
"members": {
"OptOutListName": {}
}
},
"output": {
"type": "structure",
"members": {
"OptOutListArn": {},
"OptOutListName": {},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"DeleteOptedOutNumber": {
"input": {
"type": "structure",
"required": [
"OptOutListName",
"OptedOutNumber"
],
"members": {
"OptOutListName": {},
"OptedOutNumber": {}
}
},
"output": {
"type": "structure",
"members": {
"OptOutListArn": {},
"OptOutListName": {},
"OptedOutNumber": {},
"OptedOutTimestamp": {
"type": "timestamp"
},
"EndUserOptedOut": {
"type": "boolean"
}
}
}
},
"DeletePool": {
"input": {
"type": "structure",
"required": [
"PoolId"
],
"members": {
"PoolId": {}
}
},
"output": {
"type": "structure",
"members": {
"PoolArn": {},
"PoolId": {},
"Status": {},
"MessageType": {},
"TwoWayEnabled": {
"type": "boolean"
},
"TwoWayChannelArn": {},
"TwoWayChannelRole": {},
"SelfManagedOptOutsEnabled": {
"type": "boolean"
},
"OptOutListName": {},
"SharedRoutesEnabled": {
"type": "boolean"
},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"DeleteProtectConfiguration": {
"input": {
"type": "structure",
"required": [
"ProtectConfigurationId"
],
"members": {
"ProtectConfigurationId": {}
}
},
"output": {
"type": "structure",
"required": [
"ProtectConfigurationArn",
"ProtectConfigurationId",
"CreatedTimestamp",
"AccountDefault",
"DeletionProtectionEnabled"
],
"members": {
"ProtectConfigurationArn": {},
"ProtectConfigurationId": {},
"CreatedTimestamp": {
"type": "timestamp"
},
"AccountDefault": {
"type": "boolean"
},
"DeletionProtectionEnabled": {
"type": "boolean"
}
}
}
},
"DeleteRegistration": {
"input": {
"type": "structure",
"required": [
"RegistrationId"
],
"members": {
"RegistrationId": {}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationArn",
"RegistrationId",
"RegistrationType",
"RegistrationStatus",
"CurrentVersionNumber",
"CreatedTimestamp"
],
"members": {
"RegistrationArn": {},
"RegistrationId": {},
"RegistrationType": {},
"RegistrationStatus": {},
"CurrentVersionNumber": {
"type": "long"
},
"ApprovedVersionNumber": {
"type": "long"
},
"LatestDeniedVersionNumber": {
"type": "long"
},
"AdditionalAttributes": {
"shape": "S1g"
},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"DeleteRegistrationAttachment": {
"input": {
"type": "structure",
"required": [
"RegistrationAttachmentId"
],
"members": {
"RegistrationAttachmentId": {}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationAttachmentArn",
"RegistrationAttachmentId",
"AttachmentStatus",
"CreatedTimestamp"
],
"members": {
"RegistrationAttachmentArn": {},
"RegistrationAttachmentId": {},
"AttachmentStatus": {},
"AttachmentUploadErrorReason": {},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"DeleteRegistrationFieldValue": {
"input": {
"type": "structure",
"required": [
"RegistrationId",
"FieldPath"
],
"members": {
"RegistrationId": {},
"FieldPath": {}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationArn",
"RegistrationId",
"VersionNumber",
"FieldPath"
],
"members": {
"RegistrationArn": {},
"RegistrationId": {},
"VersionNumber": {
"type": "long"
},
"FieldPath": {},
"SelectChoices": {
"shape": "S31"
},
"TextValue": {},
"RegistrationAttachmentId": {}
}
}
},
"DeleteTextMessageSpendLimitOverride": {
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"members": {
"MonthlyLimit": {
"type": "long"
}
}
}
},
"DeleteVerifiedDestinationNumber": {
"input": {
"type": "structure",
"required": [
"VerifiedDestinationNumberId"
],
"members": {
"VerifiedDestinationNumberId": {}
}
},
"output": {
"type": "structure",
"required": [
"VerifiedDestinationNumberArn",
"VerifiedDestinationNumberId",
"DestinationPhoneNumber",
"CreatedTimestamp"
],
"members": {
"VerifiedDestinationNumberArn": {},
"VerifiedDestinationNumberId": {},
"DestinationPhoneNumber": {},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"DeleteVoiceMessageSpendLimitOverride": {
"input": {
"type": "structure",
"members": {}
},
"output": {
"type": "structure",
"members": {
"MonthlyLimit": {
"type": "long"
}
}
}
},
"DescribeAccountAttributes": {
"input": {
"type": "structure",
"members": {
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"AccountAttributes": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Value"
],
"members": {
"Name": {},
"Value": {}
}
}
},
"NextToken": {}
}
}
},
"DescribeAccountLimits": {
"input": {
"type": "structure",
"members": {
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"AccountLimits": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Used",
"Max"
],
"members": {
"Name": {},
"Used": {
"type": "long"
},
"Max": {
"type": "long"
}
}
}
},
"NextToken": {}
}
}
},
"DescribeConfigurationSets": {
"input": {
"type": "structure",
"members": {
"ConfigurationSetNames": {
"type": "list",
"member": {}
},
"Filters": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Values"
],
"members": {
"Name": {},
"Values": {
"shape": "S3t"
}
}
}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"ConfigurationSets": {
"type": "list",
"member": {
"type": "structure",
"required": [
"ConfigurationSetArn",
"ConfigurationSetName",
"EventDestinations",
"CreatedTimestamp"
],
"members": {
"ConfigurationSetArn": {},
"ConfigurationSetName": {},
"EventDestinations": {
"shape": "S22"
},
"DefaultMessageType": {},
"DefaultSenderId": {},
"CreatedTimestamp": {
"type": "timestamp"
},
"ProtectConfigurationId": {}
}
}
},
"NextToken": {}
}
}
},
"DescribeKeywords": {
"input": {
"type": "structure",
"required": [
"OriginationIdentity"
],
"members": {
"OriginationIdentity": {},
"Keywords": {
"type": "list",
"member": {}
},
"Filters": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Values"
],
"members": {
"Name": {},
"Values": {
"shape": "S3t"
}
}
}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"OriginationIdentityArn": {},
"OriginationIdentity": {},
"Keywords": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Keyword",
"KeywordMessage",
"KeywordAction"
],
"members": {
"Keyword": {},
"KeywordMessage": {},
"KeywordAction": {}
}
}
},
"NextToken": {}
}
}
},
"DescribeOptOutLists": {
"input": {
"type": "structure",
"members": {
"OptOutListNames": {
"type": "list",
"member": {}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"OptOutLists": {
"type": "list",
"member": {
"type": "structure",
"required": [
"OptOutListArn",
"OptOutListName",
"CreatedTimestamp"
],
"members": {
"OptOutListArn": {},
"OptOutListName": {},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"NextToken": {}
}
}
},
"DescribeOptedOutNumbers": {
"input": {
"type": "structure",
"required": [
"OptOutListName"
],
"members": {
"OptOutListName": {},
"OptedOutNumbers": {
"type": "list",
"member": {}
},
"Filters": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Values"
],
"members": {
"Name": {},
"Values": {
"shape": "S3t"
}
}
}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"OptOutListArn": {},
"OptOutListName": {},
"OptedOutNumbers": {
"type": "list",
"member": {
"type": "structure",
"required": [
"OptedOutNumber",
"OptedOutTimestamp",
"EndUserOptedOut"
],
"members": {
"OptedOutNumber": {},
"OptedOutTimestamp": {
"type": "timestamp"
},
"EndUserOptedOut": {
"type": "boolean"
}
}
}
},
"NextToken": {}
}
}
},
"DescribePhoneNumbers": {
"input": {
"type": "structure",
"members": {
"PhoneNumberIds": {
"type": "list",
"member": {}
},
"Filters": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Values"
],
"members": {
"Name": {},
"Values": {
"shape": "S3t"
}
}
}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"PhoneNumbers": {
"type": "list",
"member": {
"type": "structure",
"required": [
"PhoneNumberArn",
"PhoneNumber",
"Status",
"IsoCountryCode",
"MessageType",
"NumberCapabilities",
"NumberType",
"MonthlyLeasingPrice",
"TwoWayEnabled",
"SelfManagedOptOutsEnabled",
"OptOutListName",
"DeletionProtectionEnabled",
"CreatedTimestamp"
],
"members": {
"PhoneNumberArn": {},
"PhoneNumberId": {},
"PhoneNumber": {},
"Status": {},
"IsoCountryCode": {},
"MessageType": {},
"NumberCapabilities": {
"shape": "S4t"
},
"NumberType": {},
"MonthlyLeasingPrice": {},
"TwoWayEnabled": {
"type": "boolean"
},
"TwoWayChannelArn": {},
"TwoWayChannelRole": {},
"SelfManagedOptOutsEnabled": {
"type": "boolean"
},
"OptOutListName": {},
"DeletionProtectionEnabled": {
"type": "boolean"
},
"PoolId": {},
"RegistrationId": {},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"NextToken": {}
}
}
},
"DescribePools": {
"input": {
"type": "structure",
"members": {
"PoolIds": {
"type": "list",
"member": {}
},
"Filters": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Values"
],
"members": {
"Name": {},
"Values": {
"shape": "S3t"
}
}
}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"Pools": {
"type": "list",
"member": {
"type": "structure",
"required": [
"PoolArn",
"PoolId",
"Status",
"MessageType",
"TwoWayEnabled",
"SelfManagedOptOutsEnabled",
"OptOutListName",
"SharedRoutesEnabled",
"DeletionProtectionEnabled",
"CreatedTimestamp"
],
"members": {
"PoolArn": {},
"PoolId": {},
"Status": {},
"MessageType": {},
"TwoWayEnabled": {
"type": "boolean"
},
"TwoWayChannelArn": {},
"TwoWayChannelRole": {},
"SelfManagedOptOutsEnabled": {
"type": "boolean"
},
"OptOutListName": {},
"SharedRoutesEnabled": {
"type": "boolean"
},
"DeletionProtectionEnabled": {
"type": "boolean"
},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"NextToken": {}
}
}
},
"DescribeProtectConfigurations": {
"input": {
"type": "structure",
"members": {
"ProtectConfigurationIds": {
"type": "list",
"member": {}
},
"Filters": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Values"
],
"members": {
"Name": {},
"Values": {
"shape": "S3t"
}
}
}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"ProtectConfigurations": {
"type": "list",
"member": {
"type": "structure",
"required": [
"ProtectConfigurationArn",
"ProtectConfigurationId",
"CreatedTimestamp",
"AccountDefault",
"DeletionProtectionEnabled"
],
"members": {
"ProtectConfigurationArn": {},
"ProtectConfigurationId": {},
"CreatedTimestamp": {
"type": "timestamp"
},
"AccountDefault": {
"type": "boolean"
},
"DeletionProtectionEnabled": {
"type": "boolean"
}
}
}
},
"NextToken": {}
}
}
},
"DescribeRegistrationAttachments": {
"input": {
"type": "structure",
"members": {
"RegistrationAttachmentIds": {
"type": "list",
"member": {}
},
"Filters": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Values"
],
"members": {
"Name": {},
"Values": {
"shape": "S3t"
}
}
}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationAttachments"
],
"members": {
"RegistrationAttachments": {
"type": "list",
"member": {
"type": "structure",
"required": [
"RegistrationAttachmentArn",
"RegistrationAttachmentId",
"AttachmentStatus",
"CreatedTimestamp"
],
"members": {
"RegistrationAttachmentArn": {},
"RegistrationAttachmentId": {},
"AttachmentStatus": {},
"AttachmentUploadErrorReason": {},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"NextToken": {}
}
}
},
"DescribeRegistrationFieldDefinitions": {
"input": {
"type": "structure",
"required": [
"RegistrationType"
],
"members": {
"RegistrationType": {},
"SectionPath": {},
"FieldPaths": {
"shape": "S5m"
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationType",
"RegistrationFieldDefinitions"
],
"members": {
"RegistrationType": {},
"RegistrationFieldDefinitions": {
"type": "list",
"member": {
"type": "structure",
"required": [
"SectionPath",
"FieldPath",
"FieldType",
"FieldRequirement",
"DisplayHints"
],
"members": {
"SectionPath": {},
"FieldPath": {},
"FieldType": {},
"FieldRequirement": {},
"SelectValidation": {
"type": "structure",
"required": [
"MinChoices",
"MaxChoices",
"Options"
],
"members": {
"MinChoices": {
"type": "integer"
},
"MaxChoices": {
"type": "integer"
},
"Options": {
"type": "list",
"member": {}
}
}
},
"TextValidation": {
"type": "structure",
"required": [
"MinLength",
"MaxLength",
"Pattern"
],
"members": {
"MinLength": {
"type": "integer"
},
"MaxLength": {
"type": "integer"
},
"Pattern": {}
}
},
"DisplayHints": {
"type": "structure",
"required": [
"Title",
"ShortDescription"
],
"members": {
"Title": {},
"ShortDescription": {},
"LongDescription": {},
"DocumentationTitle": {},
"DocumentationLink": {},
"SelectOptionDescriptions": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Option"
],
"members": {
"Option": {},
"Title": {},
"Description": {}
}
}
},
"TextValidationDescription": {},
"ExampleTextValue": {}
}
}
}
}
},
"NextToken": {}
}
}
},
"DescribeRegistrationFieldValues": {
"input": {
"type": "structure",
"required": [
"RegistrationId"
],
"members": {
"RegistrationId": {},
"VersionNumber": {
"type": "long"
},
"SectionPath": {},
"FieldPaths": {
"shape": "S5m"
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationArn",
"RegistrationId",
"VersionNumber",
"RegistrationFieldValues"
],
"members": {
"RegistrationArn": {},
"RegistrationId": {},
"VersionNumber": {
"type": "long"
},
"RegistrationFieldValues": {
"type": "list",
"member": {
"type": "structure",
"required": [
"FieldPath"
],
"members": {
"FieldPath": {},
"SelectChoices": {
"shape": "S31"
},
"TextValue": {},
"RegistrationAttachmentId": {},
"DeniedReason": {}
}
}
},
"NextToken": {}
}
}
},
"DescribeRegistrationSectionDefinitions": {
"input": {
"type": "structure",
"required": [
"RegistrationType"
],
"members": {
"RegistrationType": {},
"SectionPaths": {
"type": "list",
"member": {}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationType",
"RegistrationSectionDefinitions"
],
"members": {
"RegistrationType": {},
"RegistrationSectionDefinitions": {
"type": "list",
"member": {
"type": "structure",
"required": [
"SectionPath",
"DisplayHints"
],
"members": {
"SectionPath": {},
"DisplayHints": {
"type": "structure",
"required": [
"Title",
"ShortDescription"
],
"members": {
"Title": {},
"ShortDescription": {},
"LongDescription": {},
"DocumentationTitle": {},
"DocumentationLink": {}
}
}
}
}
},
"NextToken": {}
}
}
},
"DescribeRegistrationTypeDefinitions": {
"input": {
"type": "structure",
"members": {
"RegistrationTypes": {
"type": "list",
"member": {}
},
"Filters": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Values"
],
"members": {
"Name": {},
"Values": {
"shape": "S3t"
}
}
}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationTypeDefinitions"
],
"members": {
"RegistrationTypeDefinitions": {
"type": "list",
"member": {
"type": "structure",
"required": [
"RegistrationType",
"DisplayHints"
],
"members": {
"RegistrationType": {},
"SupportedAssociations": {
"type": "list",
"member": {
"type": "structure",
"required": [
"ResourceType",
"AssociationBehavior",
"DisassociationBehavior"
],
"members": {
"ResourceType": {},
"IsoCountryCode": {},
"AssociationBehavior": {},
"DisassociationBehavior": {}
}
}
},
"DisplayHints": {
"type": "structure",
"required": [
"Title"
],
"members": {
"Title": {},
"ShortDescription": {},
"LongDescription": {},
"DocumentationTitle": {},
"DocumentationLink": {}
}
}
}
}
},
"NextToken": {}
}
}
},
"DescribeRegistrationVersions": {
"input": {
"type": "structure",
"required": [
"RegistrationId"
],
"members": {
"RegistrationId": {},
"VersionNumbers": {
"type": "list",
"member": {
"type": "long"
}
},
"Filters": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Values"
],
"members": {
"Name": {},
"Values": {
"shape": "S3t"
}
}
}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"required": [
"RegistrationArn",
"RegistrationId",
"RegistrationVersions"
],
"members": {
"RegistrationArn": {},
"RegistrationId": {},
"RegistrationVersions": {
"type": "list",
"member": {
"type": "structure",
"required": [
"VersionNumber",
"RegistrationVersionStatus",
"RegistrationVersionStatusHistory"
],
"members": {
"VersionNumber": {
"type": "long"
},
"RegistrationVersionStatus": {},
"RegistrationVersionStatusHistory": {
"shape": "S1u"
},
"DeniedReasons": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Reason",
"ShortDescription"
],
"members": {
"Reason": {},
"ShortDescription": {},
"LongDescription": {},
"DocumentationTitle": {},
"DocumentationLink": {}
}
}
}
}
}
},
"NextToken": {}
}
}
},
"DescribeRegistrations": {
"input": {
"type": "structure",
"members": {
"RegistrationIds": {
"type": "list",
"member": {}
},
"Filters": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Values"
],
"members": {
"Name": {},
"Values": {
"shape": "S3t"
}
}
}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"required": [
"Registrations"
],
"members": {
"Registrations": {
"type": "list",
"member": {
"type": "structure",
"required": [
"RegistrationArn",
"RegistrationId",
"RegistrationType",
"RegistrationStatus",
"CurrentVersionNumber",
"CreatedTimestamp"
],
"members": {
"RegistrationArn": {},
"RegistrationId": {},
"RegistrationType": {},
"RegistrationStatus": {},
"CurrentVersionNumber": {
"type": "long"
},
"ApprovedVersionNumber": {
"type": "long"
},
"LatestDeniedVersionNumber": {
"type": "long"
},
"AdditionalAttributes": {
"shape": "S1g"
},
"CreatedTimestamp": {
"type": "timestamp"
}
}
}
},
"NextToken": {}
}
}
},
"DescribeSenderIds": {
"input": {
"type": "structure",
"members": {
"SenderIds": {
"type": "list",
"member": {
"type": "structure",
"required": [
"SenderId",
"IsoCountryCode"
],
"members": {
"SenderId": {},
"IsoCountryCode": {}
}
}
},
"Filters": {
"type": "list",
"member": {
"type": "structure",
"required": [
"Name",
"Values"
],
"members": {
"Name": {},
"Values": {
"shape": "S3t"
}
}
}
},
"NextToken": {},
"MaxResults": {
"type": "integer"
}
}
},
"output": {
"type": "structure",
"members": {
"SenderIds": {
"type": "list",
"member": {
"type": "structure",
"required": [
"SenderIdArn",
"SenderId",
"IsoCountryCode",
"MessageTypes",
"MonthlyLeasingPrice",
"DeletionProtectionEnabled",
"Registered"
],
"members": {
"SenderIdArn": {},
"SenderId": {},
"IsoCountryCode": {},
"MessageTypes": {
"shape": "S7e"
},
"MonthlyLeasingPrice": {},
"DeletionProtectionEnabled": {
"type": "boolean"
},