{ "smithy": "2.0", "shapes": { "com.amazonaws.rtbfabric#AcceptLink": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#AcceptLinkRequest" }, "output": { "target": "com.amazonaws.rtbfabric#AcceptLinkResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "
Accepts a link request between gateways.
When a requester gateway requests to link with a responder gateway, the responder can use this operation to accept the link request and establish the connection.
", "smithy.api#examples": [ { "title": "Accept a link request", "documentation": "Accepts a link request from requester gateway", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "logSettings": { "applicationLogs": { "sampling": { "errorLog": 100.0, "filterLog": 0.0 } } } }, "output": { "linkId": "link-87654321", "gatewayId": "rtb-gw-12345678", "peerGatewayId": "rtb-gw-87654321", "status": "ACCEPTED", "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:35:00Z" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/gateway/{gatewayId}/link/{linkId}/accept" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "AcceptLink", "params": { "gatewayId": "rtb-gw-12345", "linkId": "link-12345", "logSettings": { "applicationLogs": { "sampling": { "errorLog": 100.0, "filterLog": 0.0 } } } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#AcceptLinkRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "attributes": { "target": "com.amazonaws.rtbfabric#LinkAttributes", "traits": { "smithy.api#documentation": "Attributes of the link.
" } }, "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings", "traits": { "smithy.api#documentation": "Settings for the application logs.
", "smithy.api#required": {} } }, "timeoutInMillis": { "target": "com.amazonaws.rtbfabric#LinkTimeoutInMillis", "traits": { "smithy.api#documentation": "The timeout value in milliseconds.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#AcceptLinkResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "peerGatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the peer gateway.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the link.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the link was created.
", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the link was updated.
", "smithy.api#required": {} } }, "direction": { "target": "com.amazonaws.rtbfabric#LinkDirection", "traits": { "smithy.api#documentation": "The direction of the link.
" } }, "flowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of flow modules.
" } }, "pendingFlowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of pending flow modules.
" } }, "attributes": { "target": "com.amazonaws.rtbfabric#LinkAttributes", "traits": { "smithy.api#documentation": "Attributes of the link.
" } }, "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings" }, "connectivityType": { "target": "com.amazonaws.rtbfabric#ConnectivityType", "traits": { "smithy.api#documentation": "The connectivity type of the link.
" } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
" } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request could not be completed because you do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.rtbfabric#AcmCertificateArn": { "type": "string", "traits": { "smithy.api#length": { "min": 75, "max": 256 }, "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov):acm:[a-z0-9-]+:[0-9]{12}:certificate/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.rtbfabric#Action": { "type": "union", "members": { "noBid": { "target": "com.amazonaws.rtbfabric#NoBidAction", "traits": { "smithy.api#documentation": "Describes a no bid action.
" } }, "headerTag": { "target": "com.amazonaws.rtbfabric#HeaderTagAction", "traits": { "smithy.api#documentation": "Describes the header tag for a bid action.
" } } }, "traits": { "smithy.api#documentation": "Describes a bid action.
" } }, "com.amazonaws.rtbfabric#ActivationPercentage": { "type": "float", "traits": { "smithy.api#range": { "min": 0, "max": 100 } } }, "com.amazonaws.rtbfabric#AssociateCertificate": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#AssociateCertificateRequest" }, "output": { "target": "com.amazonaws.rtbfabric#AssociateCertificateResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Associates an ACM certificate with a responder gateway.
", "smithy.api#examples": [ { "title": "Associate a certificate with a responder gateway", "documentation": "Associate an ACM certificate with a responder gateway", "input": { "gatewayId": "rtb-gw-12345678", "acmCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", "clientToken": "550e8400-e29b-41d4-a716-446655440000" }, "output": { "gatewayId": "rtb-gw-12345678", "acmCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", "status": "PENDING_ASSOCIATION" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/responder-gateway/{gatewayId}/certificate" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rtbfabric#AssociateCertificateRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "acmCertificateArn": { "target": "com.amazonaws.rtbfabric#AcmCertificateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ACM certificate to associate.
", "smithy.api#required": {} } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The unique identifier of the gateway.
", "smithy.api#required": {} } }, "acmCertificateArn": { "target": "com.amazonaws.rtbfabric#AcmCertificateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ACM certificate.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#CertificateAssociationStatus", "traits": { "smithy.api#documentation": "The status of the certificate association.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {}, "smithy.api#references": [ { "resource": "com.amazonaws.rtbfabric#ResponderGateway" } ] } }, "com.amazonaws.rtbfabric#AutoScalingGroupName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 } } }, "com.amazonaws.rtbfabric#AutoScalingGroupNameList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#AutoScalingGroupName" } }, "com.amazonaws.rtbfabric#AutoScalingGroupsConfiguration": { "type": "structure", "members": { "autoScalingGroupNames": { "target": "com.amazonaws.rtbfabric#AutoScalingGroupNameList", "traits": { "smithy.api#documentation": "The names of the auto scaling group.
", "smithy.api#required": {} } }, "roleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The role ARN of the auto scaling group.
", "smithy.api#pattern": "^arn:aws:iam::[0-9]{12}:role/.{1,2048}$", "smithy.api#required": {} } }, "healthCheckConfig": { "target": "com.amazonaws.rtbfabric#HealthCheckConfig", "traits": { "smithy.api#documentation": "The health check configuration for the Auto Scaling group managed endpoint.
" } } }, "traits": { "smithy.api#documentation": "Describes the configuration of an auto scaling group.
" } }, "com.amazonaws.rtbfabric#AvailableModuleSummary": { "type": "structure", "members": { "moduleId": { "target": "com.amazonaws.rtbfabric#ModuleId", "traits": { "smithy.api#documentation": "The module's ID.
", "smithy.api#required": {} } }, "moduleArn": { "target": "com.amazonaws.rtbfabric#ModuleArn", "traits": { "smithy.api#documentation": "The module's ARN.
", "smithy.api#required": {} } }, "moduleName": { "target": "com.amazonaws.rtbfabric#ModuleName", "traits": { "smithy.api#documentation": "A label, not unique: modules can share a name.
", "smithy.api#required": {} } }, "subscriptionType": { "target": "com.amazonaws.rtbfabric#SubscriptionType", "traits": { "smithy.api#documentation": "The type of access that you have to the module.
", "smithy.api#required": {} } }, "subscriptionStatus": { "target": "com.amazonaws.rtbfabric#SubscriptionStatus", "traits": { "smithy.api#documentation": "Specifies whether your access to the module is current.
", "smithy.api#required": {} } }, "marketplaceProductId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Marketplace product the module is sold under. Present only when subscriptionType is MARKETPLACE.
" } } }, "traits": { "smithy.api#documentation": "A module that you can attach, as ListAvailableModules returns it. ListAvailableModules and GetAvailableModule never return how a module is implemented.
" } }, "com.amazonaws.rtbfabric#AvailableModuleSummaryList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#AvailableModuleSummary" } }, "com.amazonaws.rtbfabric#AvailableModuleVersionSummary": { "type": "structure", "members": { "version": { "target": "com.amazonaws.rtbfabric#SemanticVersion", "traits": { "smithy.api#documentation": "The version.
", "smithy.api#required": {} } }, "moduleVersionArn": { "target": "com.amazonaws.rtbfabric#ModuleVersionArn", "traits": { "smithy.api#documentation": "The version's ARN.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#ModuleVersionStatus", "traits": { "smithy.api#documentation": "ACTIVE or DEPRECATED.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time when the version was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A version of a module that you can attach, as ListAvailableModuleVersions returns it. ListAvailableModuleVersions and GetAvailableModuleVersion never return how a version is implemented.
" } }, "com.amazonaws.rtbfabric#AvailableModuleVersionSummaryList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#AvailableModuleVersionSummary" } }, "com.amazonaws.rtbfabric#AwsResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.rtbfabric#AwsResourceIdList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#AwsResourceId" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.rtbfabric#Base64EncodedCertificateChain": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2097152 }, "smithy.api#sensitive": {} } }, "com.amazonaws.rtbfabric#CertificateAssociationStatus": { "type": "enum", "members": { "PENDING_ASSOCIATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_ASSOCIATION" } }, "ASSOCIATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATED" } }, "PENDING_DISASSOCIATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_DISASSOCIATION" } }, "DISASSOCIATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISASSOCIATED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } }, "traits": { "smithy.api#documentation": "The status of a certificate association with a gateway.
" } }, "com.amazonaws.rtbfabric#CertificateAssociationSummary": { "type": "structure", "members": { "acmCertificateArn": { "target": "com.amazonaws.rtbfabric#AcmCertificateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ACM certificate.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#CertificateAssociationStatus", "traits": { "smithy.api#documentation": "The status of the certificate association.
", "smithy.api#required": {} } }, "associatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the certificate was associated.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the certificate association was last updated.
" } } }, "traits": { "smithy.api#documentation": "Describes a summary of a certificate association.
" } }, "com.amazonaws.rtbfabric#CertificateAssociationSummaryList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#CertificateAssociationSummary" } }, "com.amazonaws.rtbfabric#CertificateAuthorityCertificates": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#Base64EncodedCertificateChain" }, "traits": { "smithy.api#length": { "min": 0, "max": 2 } } }, "com.amazonaws.rtbfabric#ClientRoutingPolicy": { "type": "enum", "members": { "AVAILABILITY_ZONE_AFFINITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AVAILABILITY_ZONE_AFFINITY" } }, "ANY_AVAILABILITY_ZONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANY_AVAILABILITY_ZONE" } } } }, "com.amazonaws.rtbfabric#ClientToken": { "type": "string", "traits": { "smithy.api#documentation": "An idempotency token of 1\u201364 printable ASCII characters. If you don't provide one, the SDK generates one.
", "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[!-~]+$" } }, "com.amazonaws.rtbfabric#ConfigurableAction": { "type": "enum", "members": { "FILTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Requires FILTER.
", "smithy.api#enumValue": "FILTER" } }, "ENRICH_REQUEST_EXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Requires ENRICH_REQUEST_EXT.
", "smithy.api#enumValue": "ENRICH_REQUEST_EXT" } }, "ENRICH_REQUEST_HEADERS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Requires ENRICH_REQUEST_HEADERS.
", "smithy.api#enumValue": "ENRICH_REQUEST_HEADERS" } }, "OBSERVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Requires READ_REQUEST_BODY or READ_REQUEST_HEADERS.
", "smithy.api#enumValue": "OBSERVE" } } }, "traits": { "smithy.api#documentation": "A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
" } }, "com.amazonaws.rtbfabric#ConfigurableActionList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#ConfigurableAction" }, "traits": { "smithy.api#length": { "min": 1, "max": 16 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.rtbfabric#ConfigurationSchema": { "type": "string", "traits": { "smithy.api#documentation": "A JSON Schema (draft-07), as a string, for the parameters that you pass in configurationValues.
Module parameters as a JSON string, validated against the version's configurationSchema (JSON Schema draft-07).
", "smithy.api#length": { "min": 1, "max": 10240 } } }, "com.amazonaws.rtbfabric#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request could not be completed because of a conflict in the current state of the resource.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.rtbfabric#ConnectivityType": { "type": "enum", "members": { "DEFAULT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEFAULT" } }, "PUBLIC_INGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PUBLIC_INGRESS" } }, "PUBLIC_EGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PUBLIC_EGRESS" } }, "EXTERNAL_INBOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXTERNAL_INBOUND" } } }, "traits": { "smithy.api#documentation": "The connectivity type for a link or gateway.
" } }, "com.amazonaws.rtbfabric#CreateInboundExternalLink": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#CreateInboundExternalLinkRequest" }, "output": { "target": "com.amazonaws.rtbfabric#CreateInboundExternalLinkResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates an inbound external link.
", "smithy.api#examples": [ { "title": "Create an inbound external link", "documentation": "Create an inbound external link for a responder gateway", "input": { "gatewayId": "rtb-gw-12345678", "clientToken": "randomClientToken", "logSettings": { "applicationLogs": { "sampling": { "errorLog": 100.0, "filterLog": 0.0 } } } }, "output": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "status": "ACTIVE", "domainName": "rtb-gw-12345678.example.com" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/responder-gateway/{gatewayId}/inbound-external-link" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "CreateInboundExternalLink", "params": { "gatewayId": "rtb-gw-12345", "clientToken": "abc123def456", "logSettings": { "applicationLogs": { "sampling": { "errorLog": 100.0, "filterLog": 0.0 } } } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#CreateInboundExternalLinkRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "attributes": { "target": "com.amazonaws.rtbfabric#LinkAttributes", "traits": { "smithy.api#documentation": "Attributes of the link.
" } }, "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings", "traits": { "smithy.api#documentation": "Settings for the application logs.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign to the resource.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#CreateInboundExternalLinkResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } }, "domainName": { "target": "com.amazonaws.rtbfabric#DomainName", "traits": { "smithy.api#documentation": "The domain name.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#CreateLink": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#CreateLinkRequest" }, "output": { "target": "com.amazonaws.rtbfabric#CreateLinkResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a new link between gateways.
Establishes a connection that allows gateways to communicate and exchange bid requests and responses.
", "smithy.api#examples": [ { "title": "Create a standard link between gateways", "documentation": "Creates a new link between two RTB applications. Requires peerGatewayId to specify the target gateway.", "input": { "gatewayId": "rtb-gw-12345678", "peerGatewayId": "rtb-gw-87654321", "logSettings": { "applicationLogs": { "sampling": { "errorLog": 100.0, "filterLog": 0.0 } } } }, "output": { "linkId": "link-87654321", "gatewayId": "rtb-gw-12345678", "peerGatewayId": "rtb-gw-87654321", "status": "PENDING_REQUEST", "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:30:00Z" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/gateway/{gatewayId}/create-link" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "CreateLink", "params": { "gatewayId": "rtb-gw-12345", "peerGatewayId": "rtb-gw-67890", "logSettings": { "applicationLogs": { "sampling": { "errorLog": 100.0, "filterLog": 0.0 } } } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#CreateLinkRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "peerGatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the peer gateway.
", "smithy.api#required": {} } }, "attributes": { "target": "com.amazonaws.rtbfabric#LinkAttributes", "traits": { "smithy.api#documentation": "Attributes of the link.
" } }, "httpResponderAllowed": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Boolean to specify if an HTTP responder is allowed.
" } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign to the resource.
" } }, "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings", "traits": { "smithy.api#documentation": "Application log settings for the link. This value is required. Under applicationLogs.sampling, the errorLog and filterLog fields set the percentage of eligible events to log. Valid values range from 0 through 100. To turn off application logs, set both fields to 0, as in {\"applicationLogs\":{\"sampling\":{\"errorLog\":0,\"filterLog\":0}}}.
The timeout value in milliseconds.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#CreateLinkResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "peerGatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the peer gateway.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the link was created.
", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the link was updated.
", "smithy.api#required": {} } }, "direction": { "target": "com.amazonaws.rtbfabric#LinkDirection", "traits": { "smithy.api#documentation": "The direction of the link.
" } }, "flowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of flow modules.
" } }, "pendingFlowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of pending flow modules.
" } }, "attributes": { "target": "com.amazonaws.rtbfabric#LinkAttributes", "traits": { "smithy.api#documentation": "Attributes of the link.
" } }, "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings" }, "connectivityType": { "target": "com.amazonaws.rtbfabric#ConnectivityType", "traits": { "smithy.api#documentation": "The connectivity type of the link.
" } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
" } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "customerProvidedId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The customer-provided unique identifier of the link.
", "smithy.api#pattern": "^[a-zA-Z0-9_-]{5,50}$" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#CreateLinkRoutingRule": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#CreateLinkRoutingRuleRequest" }, "output": { "target": "com.amazonaws.rtbfabric#CreateLinkRoutingRuleResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a routing rule for a link.
Routing rules use priority-based evaluation where lower priority numbers are evaluated first. Each rule specifies conditions that must all match for the rule to apply.
", "smithy.api#examples": [ { "title": "Create a link routing rule", "documentation": "Create a routing rule with host header and path prefix conditions", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "priority": 10, "conditions": { "hostHeader": "api.customer.com", "pathPrefix": "/openrtb/" }, "clientToken": "550e8400-e29b-41d4-a716-446655440000" }, "output": { "ruleId": "rule-abc123def456", "status": "CREATION_IN_PROGRESS", "createdAt": "2024-01-01T12:00:00Z" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/responder-gateway/{gatewayId}/link/{linkId}/routing-rule" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rtbfabric#CreateLinkRoutingRuleRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "priority": { "target": "com.amazonaws.rtbfabric#RulePriority", "traits": { "smithy.api#documentation": "The priority of the routing rule. Lower numbers are evaluated first. Valid values are 1 to 1000. Priority must be unique among non-deleted rules within a link.
", "smithy.api#required": {} } }, "conditions": { "target": "com.amazonaws.rtbfabric#RuleCondition", "traits": { "smithy.api#documentation": "The conditions for the routing rule. All specified fields must match for the rule to apply. At least one condition field must be set.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign to the resource.
" } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.rtbfabric#Gateway" }, { "resource": "com.amazonaws.rtbfabric#Link" } ] } }, "com.amazonaws.rtbfabric#CreateLinkRoutingRuleResponse": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.rtbfabric#RuleId", "traits": { "smithy.api#documentation": "The unique identifier of the routing rule.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#RuleStatus", "traits": { "smithy.api#documentation": "The status of the routing rule.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the routing rule was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#CreateOutboundExternalLink": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#CreateOutboundExternalLinkRequest" }, "output": { "target": "com.amazonaws.rtbfabric#CreateOutboundExternalLinkResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates an outbound external link.
", "smithy.api#examples": [ { "title": "Create an outbound external link", "documentation": "Create an outbound external link for a requester gateway to connect to external public responder endpoints", "input": { "gatewayId": "rtb-gw-12345678", "publicEndpoint": "https://external-responder.example.com", "clientToken": "12345678-1234-1234-1234-123456789012", "logSettings": { "applicationLogs": { "sampling": { "errorLog": 100.0, "filterLog": 0.0 } } } }, "output": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "status": "ACTIVE" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/requester-gateway/{gatewayId}/outbound-external-link" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "CreateOutboundExternalLink", "params": { "gatewayId": "rtb-gw-12345", "publicEndpoint": "https://example.com", "clientToken": "mno345pqr678", "logSettings": { "applicationLogs": { "sampling": { "errorLog": 100.0, "filterLog": 0.0 } } } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#CreateOutboundExternalLinkRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "attributes": { "target": "com.amazonaws.rtbfabric#LinkAttributes", "traits": { "smithy.api#documentation": "Attributes of the link.
" } }, "publicEndpoint": { "target": "com.amazonaws.rtbfabric#URL", "traits": { "smithy.api#documentation": "The public endpoint of the link.
", "smithy.api#required": {} } }, "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings", "traits": { "smithy.api#documentation": "Settings for the application logs.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign to the resource.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#CreateOutboundExternalLinkResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#CreateRequesterGateway": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#CreateRequesterGatewayRequest" }, "output": { "target": "com.amazonaws.rtbfabric#CreateRequesterGatewayResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a requester gateway.
", "smithy.api#examples": [ { "title": "Create a requester gateway", "documentation": "Create requester gateway", "input": { "description": "My requester gateway", "vpcId": "vpc-12345678", "subnetIds": [ "subnet-12345678", "subnet-87654321" ], "securityGroupIds": [ "sg-12345678" ], "clientToken": "12345678-1234-1234-1234-123456789012" }, "output": { "gatewayId": "rtb-gw-12345678", "domainName": "rtb-gw-12345678.example.com", "status": "ACTIVE" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/requester-gateway" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "CreateRequesterGateway", "params": { "description": "Test gateway", "vpcId": "vpc-12345678", "subnetIds": [ "subnet-12345678" ], "securityGroupIds": [ "sg-12345678" ], "clientToken": "ghi901jkl234" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#CreateRequesterGatewayRequest": { "type": "structure", "members": { "vpcId": { "target": "com.amazonaws.rtbfabric#VpcId", "traits": { "smithy.api#documentation": "The unique identifier of the Virtual Private Cloud (VPC).
", "smithy.api#required": {} } }, "subnetIds": { "target": "com.amazonaws.rtbfabric#SubnetIdList", "traits": { "smithy.api#documentation": "The unique identifiers of the subnets.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.rtbfabric#SecurityGroupIdList", "traits": { "smithy.api#documentation": "The unique identifiers of the security groups.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
An optional description for the requester gateway.
", "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign to the resource.
" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#CreateRequesterGatewayResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "domainName": { "target": "com.amazonaws.rtbfabric#DomainName", "traits": { "smithy.api#documentation": "The domain name of the requester gateway.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#RequesterGatewayStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#CreateResponderGateway": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#CreateResponderGatewayRequest" }, "output": { "target": "com.amazonaws.rtbfabric#CreateResponderGatewayResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Creates a responder gateway.
A domain name or managed endpoint is required.
The unique identifier of the Virtual Private Cloud (VPC).
", "smithy.api#required": {} } }, "subnetIds": { "target": "com.amazonaws.rtbfabric#SubnetIdList", "traits": { "smithy.api#documentation": "Unique identifiers of the subnets. A service quota for your account sets the number of Availability Zones that your subnets can span. By default, this quota is one Availability Zone. To span more Availability Zones, request a quota increase.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.rtbfabric#SecurityGroupIdList", "traits": { "smithy.api#documentation": "The unique identifiers of the security groups.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "domainName": { "target": "com.amazonaws.rtbfabric#DomainName", "traits": { "smithy.api#documentation": "The domain name for the responder gateway.
" } }, "port": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The networking port to use.
", "smithy.api#range": { "min": 1, "max": 65535 }, "smithy.api#required": {} } }, "protocol": { "target": "com.amazonaws.rtbfabric#Protocol", "traits": { "smithy.api#documentation": "The networking protocol to use.
", "smithy.api#required": {} } }, "listenerConfig": { "target": "com.amazonaws.rtbfabric#ListenerConfig" }, "trustStoreConfiguration": { "target": "com.amazonaws.rtbfabric#TrustStoreConfiguration", "traits": { "smithy.api#documentation": "The configuration of the trust store.
" } }, "managedEndpointConfiguration": { "target": "com.amazonaws.rtbfabric#ManagedEndpointConfiguration", "traits": { "smithy.api#documentation": "The configuration for the managed endpoint.
" } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
An optional description for the responder gateway.
", "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign to the resource.
" } }, "gatewayType": { "target": "com.amazonaws.rtbfabric#GatewayType", "traits": { "smithy.api#documentation": "The type of gateway. Valid values are EXTERNAL or INTERNAL.
The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. Valid values are the following:
AVAILABILITY_ZONE_AFFINITY: RTB Fabric routes each requester's traffic to gateway capacity in the requester's own Availability Zone when the gateway has capacity available there. Otherwise, RTB Fabric routes the traffic to gateway capacity in the other Availability Zones of the gateway.
ANY_AVAILABILITY_ZONE: RTB Fabric routes each requester's traffic to gateway capacity in every Availability Zone that the subnets of the gateway span. The Availability Zone that the requester is in does not change this.
If you don't specify a value, RTB Fabric uses AVAILABILITY_ZONE_AFFINITY. To get the behavior of ANY_AVAILABILITY_ZONE, create the gateway with subnets in more than one Availability Zone. RTB Fabric does not support partial Availability Zone affinity, so PARTIAL_AVAILABILITY_ZONE_AFFINITY is not a valid value. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.
The unique identifier of the gateway.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#ResponderGatewayStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } }, "listenerConfig": { "target": "com.amazonaws.rtbfabric#ListenerConfig", "traits": { "smithy.api#documentation": "The listener configuration for the responder gateway.
" } }, "externalInboundEndpoint": { "target": "com.amazonaws.rtbfabric#DomainName", "traits": { "smithy.api#documentation": "The external inbound endpoint for the responder gateway.
" } }, "clientRoutingPolicy": { "target": "com.amazonaws.rtbfabric#ClientRoutingPolicy", "traits": { "smithy.api#documentation": "The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#CustomerProvidedId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" } }, "com.amazonaws.rtbfabric#DeleteInboundExternalLink": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#DeleteInboundExternalLinkRequest" }, "output": { "target": "com.amazonaws.rtbfabric#DeleteInboundExternalLinkResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an inbound external link.
", "smithy.api#examples": [ { "title": "Delete an inbound external link", "documentation": "Delete an inbound external link", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321" }, "output": { "linkId": "link-87654321", "status": "DELETED" } } ], "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/responder-gateway/{gatewayId}/inbound-external-link/{linkId}" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "DeleteInboundExternalLink", "params": { "gatewayId": "rtb-gw-12345", "linkId": "link-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#DeleteInboundExternalLinkRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#DeleteInboundExternalLinkResponse": { "type": "structure", "members": { "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#DeleteLink": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#DeleteLinkRequest" }, "output": { "target": "com.amazonaws.rtbfabric#DeleteLinkResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a link between gateways.
Permanently removes the connection between gateways. This action cannot be undone.
", "smithy.api#examples": [ { "title": "Delete a link", "documentation": "Deletes an existing link", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321" }, "output": { "linkId": "link-87654321", "status": "PENDING_DELETION" } } ], "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/gateway/{gatewayId}/link/{linkId}" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "DeleteLink", "params": { "gatewayId": "rtb-gw-12345", "linkId": "link-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#DeleteLinkRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#DeleteLinkResponse": { "type": "structure", "members": { "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the link.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#DeleteLinkRoutingRule": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#DeleteLinkRoutingRuleRequest" }, "output": { "target": "com.amazonaws.rtbfabric#DeleteLinkRoutingRuleResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a routing rule from a link.
", "smithy.api#examples": [ { "title": "Delete a link routing rule", "documentation": "Delete a link routing rule", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "ruleId": "rule-abc123def456" }, "output": { "ruleId": "rule-abc123def456", "status": "DELETION_IN_PROGRESS" } } ], "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/responder-gateway/{gatewayId}/link/{linkId}/routing-rule/{ruleId}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rtbfabric#DeleteLinkRoutingRuleRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ruleId": { "target": "com.amazonaws.rtbfabric#RuleId", "traits": { "smithy.api#documentation": "The unique identifier of the routing rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.rtbfabric#Gateway" }, { "resource": "com.amazonaws.rtbfabric#Link" } ] } }, "com.amazonaws.rtbfabric#DeleteLinkRoutingRuleResponse": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.rtbfabric#RuleId", "traits": { "smithy.api#documentation": "The unique identifier of the routing rule.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#RuleStatus", "traits": { "smithy.api#documentation": "The status of the routing rule.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#DeleteOutboundExternalLink": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#DeleteOutboundExternalLinkRequest" }, "output": { "target": "com.amazonaws.rtbfabric#DeleteOutboundExternalLinkResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes an outbound external link.
", "smithy.api#examples": [ { "title": "Delete an outbound external link", "documentation": "Delete an outbound external link", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321" }, "output": { "linkId": "link-87654321", "status": "DELETED" } } ], "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/requester-gateway/{gatewayId}/outbound-external-link/{linkId}" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "DeleteOutboundExternalLink", "params": { "gatewayId": "rtb-gw-12345", "linkId": "link-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#DeleteOutboundExternalLinkRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#DeleteOutboundExternalLinkResponse": { "type": "structure", "members": { "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#DeleteRequesterGateway": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#DeleteRequesterGatewayRequest" }, "output": { "target": "com.amazonaws.rtbfabric#DeleteRequesterGatewayResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a requester gateway.
", "smithy.api#examples": [ { "title": "Delete a requester gateway", "documentation": "Delete requester gateway", "input": { "gatewayId": "rtb-gw-12345678" }, "output": { "gatewayId": "rtb-gw-12345678", "status": "PENDING_DELETION" } } ], "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/requester-gateway/{gatewayId}" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "DeleteRequesterGateway", "params": { "gatewayId": "rtb-gw-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#DeleteRequesterGatewayRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#DeleteRequesterGatewayResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#RequesterGatewayStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#DeleteResponderGateway": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#DeleteResponderGatewayRequest" }, "output": { "target": "com.amazonaws.rtbfabric#DeleteResponderGatewayResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Deletes a responder gateway.
", "smithy.api#examples": [ { "title": "Delete a responder gateway", "documentation": "Delete responder gateway", "input": { "gatewayId": "rtb-gw-12345678" }, "output": { "gatewayId": "rtb-gw-12345678", "status": "PENDING_DELETION" } } ], "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/responder-gateway/{gatewayId}" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "DeleteResponderGateway", "params": { "gatewayId": "rtb-gw-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#DeleteResponderGatewayRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#DeleteResponderGatewayResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#ResponderGatewayStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#DisassociateCertificate": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#DisassociateCertificateRequest" }, "output": { "target": "com.amazonaws.rtbfabric#DisassociateCertificateResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes a certificate association from a responder gateway.
", "smithy.api#examples": [ { "title": "Disassociate a certificate from a responder gateway", "documentation": "Remove an ACM certificate association from a responder gateway", "input": { "gatewayId": "rtb-gw-12345678", "acmCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" }, "output": { "gatewayId": "rtb-gw-12345678", "acmCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", "status": "PENDING_DISASSOCIATION" } } ], "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/responder-gateway/{gatewayId}/certificate" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rtbfabric#DisassociateCertificateRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "acmCertificateArn": { "target": "com.amazonaws.rtbfabric#AcmCertificateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ACM certificate to disassociate.
", "smithy.api#httpQuery": "acmCertificateArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.rtbfabric#ResponderGateway" } ] } }, "com.amazonaws.rtbfabric#DisassociateCertificateResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "acmCertificateArn": { "target": "com.amazonaws.rtbfabric#AcmCertificateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ACM certificate.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#CertificateAssociationStatus", "traits": { "smithy.api#documentation": "The status of the certificate association.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {}, "smithy.api#references": [ { "resource": "com.amazonaws.rtbfabric#ResponderGateway" } ] } }, "com.amazonaws.rtbfabric#DomainName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?:\\.(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?))+$" } }, "com.amazonaws.rtbfabric#EksEndpointsConfiguration": { "type": "structure", "members": { "endpointsResourceName": { "target": "com.amazonaws.rtbfabric#KubernetesEndpointsResourceName", "traits": { "smithy.api#documentation": "The name of the endpoint resource.
", "smithy.api#required": {} } }, "endpointsResourceNamespace": { "target": "com.amazonaws.rtbfabric#KubernetesNamespace", "traits": { "smithy.api#documentation": "The namespace of the endpoint resource.
", "smithy.api#required": {} } }, "clusterApiServerEndpointUri": { "target": "com.amazonaws.rtbfabric#URI", "traits": { "smithy.api#documentation": "The URI of the cluster API server endpoint.
", "smithy.api#required": {} } }, "clusterApiServerCaCertificateChain": { "target": "com.amazonaws.rtbfabric#Base64EncodedCertificateChain", "traits": { "smithy.api#documentation": "The CA certificate chain of the cluster API server.
", "smithy.api#required": {} } }, "clusterName": { "target": "com.amazonaws.rtbfabric#KubernetesClusterName", "traits": { "smithy.api#documentation": "The name of the cluster.
", "smithy.api#required": {} } }, "roleArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The role ARN for the cluster.
", "smithy.api#pattern": "^arn:aws:iam::[0-9]{12}:role/.{1,2048}$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.
" } }, "com.amazonaws.rtbfabric#ErrorCode": { "type": "enum", "members": { "VPC_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The VPC no longer exists.
", "smithy.api#enumValue": "VPC_NOT_FOUND" } }, "EC2_SUBNET_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "A subnet no longer exists.
", "smithy.api#enumValue": "EC2_SUBNET_NOT_FOUND" } }, "EC2_SECURITY_GROUP_NOT_FOUND": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "A security group no longer exists.
", "smithy.api#enumValue": "EC2_SECURITY_GROUP_NOT_FOUND" } }, "EC2_SUBNET_IP_EXHAUSTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "A subnet has no free IP addresses.
", "smithy.api#enumValue": "EC2_SUBNET_IP_EXHAUSTION" } }, "IAM_ASSUME_ROLE_ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "RTB Fabric was denied when it assumed an IAM role in your account.
", "smithy.api#enumValue": "IAM_ASSUME_ROLE_ACCESS_DENIED" } }, "INTERNAL_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "An internal error in RTB Fabric.
", "smithy.api#enumValue": "INTERNAL_ERROR" } } }, "traits": { "smithy.api#documentation": "Why a resource, or a change to it, failed.
" } }, "com.amazonaws.rtbfabric#ErrorDetail": { "type": "structure", "members": { "code": { "target": "com.amazonaws.rtbfabric#ErrorCode", "traits": { "smithy.api#documentation": "The error code for what failed.
", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A description of the failure.
", "smithy.api#length": { "max": 1024 }, "smithy.api#required": {} } }, "resourceIds": { "target": "com.amazonaws.rtbfabric#AwsResourceIdList", "traits": { "smithy.api#documentation": "The IDs of the resources involved, such as a subnet or security group.
" } } }, "traits": { "smithy.api#documentation": "Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
" } }, "com.amazonaws.rtbfabric#ErrorDetails": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#ErrorDetail" }, "traits": { "smithy.api#length": { "max": 10 } } }, "com.amazonaws.rtbfabric#FailureMode": { "type": "enum", "members": { "OPEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Continue the flow. The default.
", "smithy.api#enumValue": "OPEN" } }, "CLOSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Short-circuit with a no-bid.
", "smithy.api#enumValue": "CLOSED" } } }, "traits": { "smithy.api#documentation": "What the flow does when the module fails or times out.
" } }, "com.amazonaws.rtbfabric#Filter": { "type": "structure", "members": { "criteria": { "target": "com.amazonaws.rtbfabric#FilterCriteria", "traits": { "smithy.api#documentation": "Describes the criteria for a filter.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the configuration of a filter.
" } }, "com.amazonaws.rtbfabric#FilterConfiguration": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#Filter" } }, "com.amazonaws.rtbfabric#FilterCriteria": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#FilterCriterion" } }, "com.amazonaws.rtbfabric#FilterCriterion": { "type": "structure", "members": { "path": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The path to filter.
", "smithy.api#required": {} } }, "values": { "target": "com.amazonaws.rtbfabric#ValueList", "traits": { "smithy.api#documentation": "The value to filter.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the criteria for a filter.
" } }, "com.amazonaws.rtbfabric#FilterType": { "type": "enum", "members": { "INCLUDE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INCLUDE" } }, "EXCLUDE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXCLUDE" } } } }, "com.amazonaws.rtbfabric#Flow": { "type": "structure", "members": { "name": { "target": "com.amazonaws.rtbfabric#FlowName", "traits": { "smithy.api#documentation": "The flow's name, unique within the link.
", "smithy.api#required": {} } }, "pipeline": { "target": "com.amazonaws.rtbfabric#FlowPipeline", "traits": { "smithy.api#documentation": "The pipeline that the flow's modules run in. In a sequential pipeline, each module sees the previous module's output. In a phased pipeline, a phase's modules see the prior phase's output, not each other's.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "One flow on a link: a set of modules that runs on the link's bid requests.
" } }, "com.amazonaws.rtbfabric#FlowList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#Flow" }, "traits": { "smithy.api#documentation": "A link's flows: at most one.
", "smithy.api#length": { "max": 1 } } }, "com.amazonaws.rtbfabric#FlowModule": { "type": "structure", "members": { "name": { "target": "com.amazonaws.rtbfabric#ModuleName", "traits": { "smithy.api#documentation": "The module's name, unique within the flow.
", "smithy.api#required": {} } }, "moduleVersionArn": { "target": "com.amazonaws.rtbfabric#ModuleVersionArn", "traits": { "smithy.api#documentation": "The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that's already in the link's flows after it's deprecated, but you can't give it a higher share of traffic.
", "smithy.api#required": {} } }, "selectedActions": { "target": "com.amazonaws.rtbfabric#SelectedActionList", "traits": { "smithy.api#documentation": "The capabilities to turn on, chosen from the version's configurableActions. If the version exposes one, it's the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.
Specifies what happens when the module fails \u2013 when its call fails or times out, or when an express module's dataset is stale. The default is OPEN.
" } }, "activationPercentage": { "target": "com.amazonaws.rtbfabric#ActivationPercentage", "traits": { "smithy.api#documentation": "The percentage of the flow's requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
" } }, "configurationValues": { "target": "com.amazonaws.rtbfabric#ConfigurationValues", "traits": { "smithy.api#documentation": "RTB Fabric validates the value against the version's configurationSchema and rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.
A version attached to a flow, with its settings.
" } }, "com.amazonaws.rtbfabric#FlowModuleList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#FlowModule" }, "traits": { "smithy.api#length": { "min": 1, "max": 8 } } }, "com.amazonaws.rtbfabric#FlowModuleName": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^[A-Za-z0-9 -]+$" } }, "com.amazonaws.rtbfabric#FlowModuleNameList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#FlowModuleName" } }, "com.amazonaws.rtbfabric#FlowName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9-]*$" } }, "com.amazonaws.rtbfabric#FlowPhase": { "type": "structure", "members": { "modules": { "target": "com.amazonaws.rtbfabric#FlowModuleList", "traits": { "smithy.api#documentation": "At most one MUTATE_REQUEST_BODY module.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "One phase of a phased pipeline. Its modules run concurrently on the previous phase's output.
" } }, "com.amazonaws.rtbfabric#FlowPhaseList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#FlowPhase" }, "traits": { "smithy.api#length": { "min": 1, "max": 8 } } }, "com.amazonaws.rtbfabric#FlowPipeline": { "type": "union", "members": { "sequential": { "target": "com.amazonaws.rtbfabric#SequentialPipeline", "traits": { "smithy.api#documentation": "Modules run in list order. Use it when each module needs the previous module's output.
" } }, "phased": { "target": "com.amazonaws.rtbfabric#PhasedPipeline", "traits": { "smithy.api#documentation": "Phases run in order; a phase's modules run concurrently on the same input. Use it when a phase's modules don't depend on each other.
" } } }, "traits": { "smithy.api#documentation": "How a flow's modules run. In sequential, each module sees the previous module's output; in phased, a phase's modules see the prior phase's output, not each other's. Set exactly one. New members can be added, so handle an unknown one.
The type of gateway.
" } }, "com.amazonaws.rtbfabric#GetAvailableModule": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#GetAvailableModuleRequest" }, "output": { "target": "com.amazonaws.rtbfabric#GetAvailableModuleResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns a module that you can attach. If you can't attach the module, the operation returns ResourceNotFoundException, the same as for a missing one.
", "smithy.api#examples": [ { "title": "Get a module", "documentation": "Gets a Marketplace module that you can attach.", "input": { "moduleId": "module-8kq2p9wx3fnv1c5htj7bd0ral" }, "output": { "moduleId": "module-8kq2p9wx3fnv1c5htj7bd0ral", "moduleArn": "arn:aws:rtbfabric:us-east-1::modules/module-8kq2p9wx3fnv1c5htj7bd0ral", "moduleName": "bid-floor-filter", "description": "Drops bid requests whose floor price is below a value that you set.", "subscriptionType": "MARKETPLACE", "subscriptionStatus": "ACTIVE", "marketplaceProductId": "prod-abcd1234efgh5", "createdAt": "2026-10-01T12:00:00Z" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/available-modules/{moduleId}" }, "smithy.api#readonly": {} } }, "com.amazonaws.rtbfabric#GetAvailableModuleRequest": { "type": "structure", "members": { "moduleId": { "target": "com.amazonaws.rtbfabric#ModuleId", "traits": { "smithy.api#documentation": "The module's ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#GetAvailableModuleResponse": { "type": "structure", "members": { "moduleId": { "target": "com.amazonaws.rtbfabric#ModuleId", "traits": { "smithy.api#documentation": "The module's ID.
", "smithy.api#required": {} } }, "moduleArn": { "target": "com.amazonaws.rtbfabric#ModuleArn", "traits": { "smithy.api#documentation": "The module's ARN.
", "smithy.api#required": {} } }, "moduleName": { "target": "com.amazonaws.rtbfabric#ModuleName", "traits": { "smithy.api#documentation": "A label, not unique: modules can share a name.
", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.rtbfabric#ModuleDescription", "traits": { "smithy.api#documentation": "The module's description.
" } }, "subscriptionType": { "target": "com.amazonaws.rtbfabric#SubscriptionType", "traits": { "smithy.api#documentation": "The type of access that you have to the module.
", "smithy.api#required": {} } }, "subscriptionStatus": { "target": "com.amazonaws.rtbfabric#SubscriptionStatus", "traits": { "smithy.api#documentation": "Specifies whether your access to the module is current.
", "smithy.api#required": {} } }, "marketplaceProductId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The Marketplace product the module is sold under. Present only when subscriptionType is MARKETPLACE.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time when the module was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#GetAvailableModuleVersion": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#GetAvailableModuleVersionRequest" }, "output": { "target": "com.amazonaws.rtbfabric#GetAvailableModuleVersionResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Returns an ACTIVE or DEPRECATED version of a module that you can attach. If you can't attach the module, or the version is in another status, the operation returns ResourceNotFoundException, the same as for a missing one.
", "smithy.api#examples": [ { "title": "Get a module version", "documentation": "Gets a version of a module that you can attach, with what it can do and the parameters it accepts.", "input": { "moduleId": "module-8kq2p9wx3fnv1c5htj7bd0ral", "version": "1.2.0" }, "output": { "moduleId": "module-8kq2p9wx3fnv1c5htj7bd0ral", "version": "1.2.0", "moduleVersionArn": "arn:aws:rtbfabric:us-east-1::modules/module-8kq2p9wx3fnv1c5htj7bd0ral/versions/1.2.0", "status": "ACTIVE", "permissions": [ "READ_REQUEST_BODY", "FILTER" ], "configurableActions": [ "FILTER" ], "configurationSchema": "{\"type\":\"object\",\"properties\":{\"floorPrice\":{\"type\":\"number\"}}}", "releaseNotes": "Adds a configurable floor price.", "createdAt": "2026-10-15T09:00:00Z", "updatedAt": "2026-10-15T09:00:00Z" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/available-modules/{moduleId}/versions/{version}" }, "smithy.api#readonly": {} } }, "com.amazonaws.rtbfabric#GetAvailableModuleVersionRequest": { "type": "structure", "members": { "moduleId": { "target": "com.amazonaws.rtbfabric#ModuleId", "traits": { "smithy.api#documentation": "The module's ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.rtbfabric#SemanticVersion", "traits": { "smithy.api#documentation": "The version.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#GetAvailableModuleVersionResponse": { "type": "structure", "members": { "moduleId": { "target": "com.amazonaws.rtbfabric#ModuleId", "traits": { "smithy.api#documentation": "The module's ID.
", "smithy.api#required": {} } }, "version": { "target": "com.amazonaws.rtbfabric#SemanticVersion", "traits": { "smithy.api#documentation": "The version.
", "smithy.api#required": {} } }, "moduleVersionArn": { "target": "com.amazonaws.rtbfabric#ModuleVersionArn", "traits": { "smithy.api#documentation": "The version's ARN.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#ModuleVersionStatus", "traits": { "smithy.api#documentation": "ACTIVE or DEPRECATED.
", "smithy.api#required": {} } }, "permissions": { "target": "com.amazonaws.rtbfabric#ModulePermissionList", "traits": { "smithy.api#documentation": "The data-access grants the version holds.
", "smithy.api#required": {} } }, "configurableActions": { "target": "com.amazonaws.rtbfabric#ConfigurableActionList", "traits": { "smithy.api#documentation": "The capabilities that you can turn on when you attach the version.
", "smithy.api#required": {} } }, "configurationSchema": { "target": "com.amazonaws.rtbfabric#ConfigurationSchema", "traits": { "smithy.api#documentation": "The JSON Schema for the parameters that you can set in configurationValues when you attach the version.
The vendor's release notes.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time when the version was created.
", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The time when the version last changed.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#GetCertificateAssociation": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#GetCertificateAssociationRequest" }, "output": { "target": "com.amazonaws.rtbfabric#GetCertificateAssociationResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the details of a certificate association with a responder gateway.
", "smithy.api#examples": [ { "title": "Get certificate association details from a responder gateway", "documentation": "Retrieve details of an ACM certificate association with a responder gateway", "input": { "gatewayId": "rtb-gw-12345678", "acmCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" }, "output": { "gatewayId": "rtb-gw-12345678", "acmCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", "status": "ASSOCIATED", "associatedAt": 1704067200, "updatedAt": 1704067200 } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/responder-gateway/{gatewayId}/certificate" }, "smithy.api#readonly": {}, "smithy.waiters#waitable": { "CertificateAssociated": { "minDelay": 15, "acceptors": [ { "state": "success", "matcher": { "output": { "path": "status", "expected": "ASSOCIATED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "errorType": "ResourceNotFoundException" } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DISASSOCIATED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "PENDING_DISASSOCIATION", "comparator": "stringEquals" } } } ] }, "CertificateDisassociated": { "minDelay": 15, "acceptors": [ { "state": "success", "matcher": { "output": { "path": "status", "expected": "DISASSOCIATED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "errorType": "ResourceNotFoundException" } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "PENDING_ASSOCIATION", "comparator": "stringEquals" } } } ] } } } }, "com.amazonaws.rtbfabric#GetCertificateAssociationRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "acmCertificateArn": { "target": "com.amazonaws.rtbfabric#AcmCertificateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ACM certificate.
", "smithy.api#httpQuery": "acmCertificateArn", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.rtbfabric#ResponderGateway" } ] } }, "com.amazonaws.rtbfabric#GetCertificateAssociationResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "acmCertificateArn": { "target": "com.amazonaws.rtbfabric#AcmCertificateArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the ACM certificate.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#CertificateAssociationStatus", "traits": { "smithy.api#documentation": "The status of the certificate association.
", "smithy.api#required": {} } }, "associatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the certificate was associated.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the certificate association was last updated.
" } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
" } } }, "traits": { "smithy.api#output": {}, "smithy.api#references": [ { "resource": "com.amazonaws.rtbfabric#ResponderGateway" } ] } }, "com.amazonaws.rtbfabric#GetInboundExternalLink": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#GetInboundExternalLinkRequest" }, "output": { "target": "com.amazonaws.rtbfabric#GetInboundExternalLinkResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information about an inbound external link.
", "smithy.api#examples": [ { "title": "Get inbound external link details", "documentation": "Get details of an inbound external link", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321" }, "output": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "status": "ACTIVE", "domainName": "rtb-gw-12345678.123456789012.gateway.rtbfabric.us-east-1.amazonaws.com", "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:35:00Z" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/responder-gateway/{gatewayId}/inbound-external-link/{linkId}" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetInboundExternalLink", "params": { "gatewayId": "rtb-gw-12345", "linkId": "link-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ], "smithy.waiters#waitable": { "InboundExternalLinkActive": { "minDelay": 30, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "CREATE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "ACTIVE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "REJECTED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "ISOLATED", "comparator": "stringEquals" } } } ] }, "InboundExternalLinkDeleted": { "minDelay": 30, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "REJECTED", "comparator": "stringEquals" } } } ] } } } }, "com.amazonaws.rtbfabric#GetInboundExternalLinkRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#GetInboundExternalLinkResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } }, "domainName": { "target": "com.amazonaws.rtbfabric#DomainName", "traits": { "smithy.api#documentation": "The domain name.
", "smithy.api#required": {} } }, "flowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of flow modules.
" } }, "pendingFlowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of pending flow modules.
" } }, "attributes": { "target": "com.amazonaws.rtbfabric#LinkAttributes", "traits": { "smithy.api#documentation": "Attributes of the link.
" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the inbound external link was created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the inbound external link was updated.
" } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs for the tag or tags assigned to the specified resource.
", "smithy.api#notProperty": {} } }, "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings", "traits": { "smithy.api#documentation": "Settings for the application logs.
" } }, "connectivityType": { "target": "com.amazonaws.rtbfabric#ConnectivityType", "traits": { "smithy.api#documentation": "The connectivity type of the link.
" } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
" } }, "lockToken": { "target": "com.amazonaws.rtbfabric#LockToken", "traits": { "smithy.api#documentation": "The link's concurrency token. Pass it to PutLinkFlows unchanged; it changes whenever the link does.
" } }, "flows": { "target": "com.amazonaws.rtbfabric#FlowList", "traits": { "smithy.api#documentation": "The link's active flows, in the form PutLinkFlows takes. Empty when the link has no modules, and absent when its modules were set with UpdateLinkModuleFlow.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#GetLink": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#GetLinkRequest" }, "output": { "target": "com.amazonaws.rtbfabric#GetLinkResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information about a link between gateways.
Returns detailed information about the link configuration, status, and associated gateways.
", "smithy.api#examples": [ { "title": "Get link details", "documentation": "Retrieves details of a specific link", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321" }, "output": { "linkId": "link-87654321", "gatewayId": "rtb-gw-12345678", "peerGatewayId": "rtb-gw-87654321", "status": "ACTIVE", "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:35:00Z" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/gateway/{gatewayId}/link/{linkId}" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetLink", "params": { "linkId": "link-12345", "gatewayId": "rtb-gw-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ], "smithy.waiters#waitable": { "LinkAccepted": { "minDelay": 30, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "CREATE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "ACCEPTED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "REJECTED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } } ] }, "LinkActive": { "minDelay": 30, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "CREATE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "ACTIVE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "REJECTED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } } ] }, "LinkDeleted": { "minDelay": 30, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "REJECTED", "comparator": "stringEquals" } } } ] } } } }, "com.amazonaws.rtbfabric#GetLinkRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#GetLinkResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "peerGatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the peer gateway.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the link.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the link was created.
", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the link was updated.
", "smithy.api#required": {} } }, "direction": { "target": "com.amazonaws.rtbfabric#LinkDirection", "traits": { "smithy.api#documentation": "The direction of the link.
" } }, "flowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of flow modules.
" } }, "pendingFlowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of pending flow modules.
" } }, "attributes": { "target": "com.amazonaws.rtbfabric#LinkAttributes", "traits": { "smithy.api#documentation": "Attributes of the link.
" } }, "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings", "traits": { "smithy.api#documentation": "Settings for the application logs.
" } }, "connectivityType": { "target": "com.amazonaws.rtbfabric#ConnectivityType", "traits": { "smithy.api#documentation": "The connectivity type of the link.
" } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
" } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs for the tag or tags assigned to the specified resource.
" } }, "httpResponderAllowed": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "Boolean to specify if an HTTP responder is allowed.
" } }, "timeoutInMillis": { "target": "com.amazonaws.rtbfabric#LinkTimeoutInMillis", "traits": { "smithy.api#documentation": "The timeout value in milliseconds.
" } }, "lockToken": { "target": "com.amazonaws.rtbfabric#LockToken", "traits": { "smithy.api#documentation": "The link's concurrency token. Pass it to PutLinkFlows unchanged; it changes whenever the link does.
" } }, "flows": { "target": "com.amazonaws.rtbfabric#FlowList", "traits": { "smithy.api#documentation": "The link's active flows, in the form PutLinkFlows takes. Empty when the link has no modules, and absent when its modules were set with UpdateLinkModuleFlow.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#GetLinkRoutingRule": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#GetLinkRoutingRuleRequest" }, "output": { "target": "com.amazonaws.rtbfabric#GetLinkRoutingRuleResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves the details of a routing rule for a link.
", "smithy.api#examples": [ { "title": "Get link routing rule details", "documentation": "Get details of a link routing rule", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "ruleId": "rule-abc123def456" }, "output": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "ruleId": "rule-abc123def456", "priority": 10, "conditions": { "hostHeader": "api.customer.com", "pathPrefix": "/openrtb/" }, "status": "ACTIVE", "createdAt": "2024-01-01T12:00:00Z", "updatedAt": "2024-01-01T12:00:00Z" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/responder-gateway/{gatewayId}/link/{linkId}/routing-rule/{ruleId}" }, "smithy.api#readonly": {}, "smithy.waiters#waitable": { "LinkRoutingRuleActive": { "minDelay": 5, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "CREATE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "ACTIVE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } } ] }, "LinkRoutingRuleDeleted": { "minDelay": 5, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "errorType": "ResourceNotFoundException" } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } } ] } } } }, "com.amazonaws.rtbfabric#GetLinkRoutingRuleRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ruleId": { "target": "com.amazonaws.rtbfabric#RuleId", "traits": { "smithy.api#documentation": "The unique identifier of the routing rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.rtbfabric#Gateway" }, { "resource": "com.amazonaws.rtbfabric#Link" } ] } }, "com.amazonaws.rtbfabric#GetLinkRoutingRuleResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "ruleId": { "target": "com.amazonaws.rtbfabric#RuleId", "traits": { "smithy.api#documentation": "The unique identifier of the routing rule.
", "smithy.api#required": {} } }, "priority": { "target": "com.amazonaws.rtbfabric#RulePriority", "traits": { "smithy.api#documentation": "The priority of the routing rule.
", "smithy.api#required": {} } }, "conditions": { "target": "com.amazonaws.rtbfabric#RuleCondition", "traits": { "smithy.api#documentation": "The conditions for the routing rule.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#RuleStatus", "traits": { "smithy.api#documentation": "The status of the routing rule.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the routing rule was created.
", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the routing rule was last updated.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs for the tag or tags assigned to the specified resource.
" } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
" } } }, "traits": { "smithy.api#output": {}, "smithy.api#references": [ { "resource": "com.amazonaws.rtbfabric#Gateway" }, { "resource": "com.amazonaws.rtbfabric#Link" } ] } }, "com.amazonaws.rtbfabric#GetOutboundExternalLink": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#GetOutboundExternalLinkRequest" }, "output": { "target": "com.amazonaws.rtbfabric#GetOutboundExternalLinkResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information about an outbound external link.
", "smithy.api#examples": [ { "title": "Get outbound external link details", "documentation": "Get details of a specific outbound external link", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321" }, "output": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "status": "ACTIVE", "publicEndpoint": "https://external-responder.example.com", "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:35:00Z" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/requester-gateway/{gatewayId}/outbound-external-link/{linkId}" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetOutboundExternalLink", "params": { "gatewayId": "rtb-gw-12345", "linkId": "link-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ], "smithy.waiters#waitable": { "OutboundExternalLinkActive": { "minDelay": 30, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "CREATE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "ACTIVE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "REJECTED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "ISOLATED", "comparator": "stringEquals" } } } ] }, "OutboundExternalLinkDeleted": { "minDelay": 30, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "REJECTED", "comparator": "stringEquals" } } } ] } } } }, "com.amazonaws.rtbfabric#GetOutboundExternalLinkRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#GetOutboundExternalLinkResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } }, "publicEndpoint": { "target": "com.amazonaws.rtbfabric#URL", "traits": { "smithy.api#documentation": "The public endpoint for the link.
", "smithy.api#required": {} } }, "flowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of flow modules.
" } }, "pendingFlowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of pending flow modules.
" } }, "attributes": { "target": "com.amazonaws.rtbfabric#LinkAttributes" }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the outbound external link was created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the outbound external link was updated.
" } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs for the tag or tags assigned to the specified resource.
", "smithy.api#notProperty": {} } }, "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings", "traits": { "smithy.api#documentation": "Settings for the application logs.
" } }, "connectivityType": { "target": "com.amazonaws.rtbfabric#ConnectivityType", "traits": { "smithy.api#documentation": "The connectivity type of the link.
" } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
" } }, "lockToken": { "target": "com.amazonaws.rtbfabric#LockToken", "traits": { "smithy.api#documentation": "The link's concurrency token. Pass it to PutLinkFlows unchanged; it changes whenever the link does.
" } }, "flows": { "target": "com.amazonaws.rtbfabric#FlowList", "traits": { "smithy.api#documentation": "The link's active flows, in the form PutLinkFlows takes. Empty when the link has no modules, and absent when its modules were set with UpdateLinkModuleFlow.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#GetRequesterGateway": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#GetRequesterGatewayRequest" }, "output": { "target": "com.amazonaws.rtbfabric#GetRequesterGatewayResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information about a requester gateway.
", "smithy.api#examples": [ { "title": "Get requester gateway details", "documentation": "Get requester gateway", "input": { "gatewayId": "rtb-gw-12345678" }, "output": { "gatewayId": "rtb-gw-12345678", "status": "ACTIVE", "domainName": "rtb-gw-12345678.example.com", "description": "My requester gateway", "vpcId": "vpc-12345678", "subnetIds": [ "subnet-12345678", "subnet-87654321" ], "securityGroupIds": [ "sg-12345678" ], "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:35:00Z", "activeLinksCount": 2, "totalLinksCount": 5 } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/requester-gateway/{gatewayId}" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetRequesterGateway", "params": { "gatewayId": "rtb-gw-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ], "smithy.waiters#waitable": { "RequesterGatewayActive": { "minDelay": 30, "maxDelay": 120, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "CREATE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "ACTIVE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "ERROR", "comparator": "stringEquals" } } } ] }, "RequesterGatewayDeleted": { "minDelay": 30, "maxDelay": 120, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "errorType": "ResourceNotFoundException" } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "ERROR", "comparator": "stringEquals" } } } ] } } } }, "com.amazonaws.rtbfabric#GetRequesterGatewayRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#GetRequesterGatewayResponse": { "type": "structure", "members": { "status": { "target": "com.amazonaws.rtbfabric#RequesterGatewayStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } }, "domainName": { "target": "com.amazonaws.rtbfabric#DomainName", "traits": { "smithy.api#documentation": "The domain name of the requester gateway.
", "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the requester gateway.
", "smithy.api#pattern": "^[A-Za-z0-9 ]+$" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the requester gateway was created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the requester gateway was updated.
" } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
" } }, "vpcId": { "target": "com.amazonaws.rtbfabric#VpcId", "traits": { "smithy.api#documentation": "The unique identifier of the Virtual Private Cloud (VPC).
", "smithy.api#required": {} } }, "subnetIds": { "target": "com.amazonaws.rtbfabric#SubnetIdList", "traits": { "smithy.api#documentation": "The unique identifiers of the subnets.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.rtbfabric#SecurityGroupIdList", "traits": { "smithy.api#documentation": "The unique identifiers of the security groups.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs for the tag or tags assigned to the specified resource.
" } }, "activeLinksCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The count of active links for the requester gateway.
" } }, "totalLinksCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The total count of links for the requester gateway.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#GetResponderGateway": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#GetResponderGatewayRequest" }, "output": { "target": "com.amazonaws.rtbfabric#GetResponderGatewayResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Retrieves information about a responder gateway.
", "smithy.api#examples": [ { "title": "Get responder gateway details", "documentation": "Get responder gateway", "input": { "gatewayId": "rtb-gw-12345678" }, "output": { "gatewayId": "rtb-gw-12345678", "status": "ACTIVE", "description": "My responder gateway", "vpcId": "vpc-12345678", "subnetIds": [ "subnet-12345678", "subnet-87654321" ], "securityGroupIds": [ "sg-12345678" ], "port": 443, "protocol": "HTTPS", "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:35:00Z", "activeLinksCount": 2, "totalLinksCount": 5, "linksRequestedCount": 3 } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/responder-gateway/{gatewayId}" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "GetResponderGateway", "params": { "gatewayId": "rtb-gw-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ], "smithy.waiters#waitable": { "ResponderGatewayActive": { "minDelay": 30, "maxDelay": 120, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "CREATE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "ACTIVE", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "ERROR", "comparator": "stringEquals" } } } ] }, "ResponderGatewayDeleted": { "minDelay": 30, "maxDelay": 120, "acceptors": [ { "state": "failure", "matcher": { "output": { "path": "status", "expected": "DELETE_FAILED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "output": { "path": "status", "expected": "DELETED", "comparator": "stringEquals" } } }, { "state": "success", "matcher": { "errorType": "ResourceNotFoundException" } }, { "state": "failure", "matcher": { "output": { "path": "status", "expected": "ERROR", "comparator": "stringEquals" } } } ] } } } }, "com.amazonaws.rtbfabric#GetResponderGatewayRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#GetResponderGatewayResponse": { "type": "structure", "members": { "vpcId": { "target": "com.amazonaws.rtbfabric#VpcId", "traits": { "smithy.api#documentation": "The unique identifier of the Virtual Private Cloud (VPC).
", "smithy.api#required": {} } }, "subnetIds": { "target": "com.amazonaws.rtbfabric#SubnetIdList", "traits": { "smithy.api#documentation": "The unique identifiers of the subnets.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "securityGroupIds": { "target": "com.amazonaws.rtbfabric#SecurityGroupIdList", "traits": { "smithy.api#documentation": "The unique identifiers of the security groups.
", "smithy.api#length": { "min": 1 }, "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#ResponderGatewayStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The description of the responder gateway.
", "smithy.api#pattern": "^[A-Za-z0-9 ]+$" } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the responder gateway was created.
" } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the responder gateway was updated.
" } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
" } }, "domainName": { "target": "com.amazonaws.rtbfabric#DomainName", "traits": { "smithy.api#documentation": "The domain name of the responder gateway.
" } }, "port": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The networking port.
", "smithy.api#range": { "min": 1, "max": 65535 }, "smithy.api#required": {} } }, "protocol": { "target": "com.amazonaws.rtbfabric#Protocol", "traits": { "smithy.api#documentation": "The networking protocol.
", "smithy.api#required": {} } }, "listenerConfig": { "target": "com.amazonaws.rtbfabric#ListenerConfig", "traits": { "smithy.api#documentation": "The listener configuration for the responder gateway.
" } }, "trustStoreConfiguration": { "target": "com.amazonaws.rtbfabric#TrustStoreConfiguration", "traits": { "smithy.api#documentation": "The configuration of the trust store.
" } }, "managedEndpointConfiguration": { "target": "com.amazonaws.rtbfabric#ManagedEndpointConfiguration", "traits": { "smithy.api#documentation": "The configuration of the managed endpoint.
" } }, "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs for the tag or tags assigned to the specified resource.
" } }, "activeLinksCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The count of active links for the responder gateway.
" } }, "totalLinksCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The total count of links for the responder gateway.
" } }, "linksRequestedCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The count of requested links waiting for the responder gateway to accept or reject.
" } }, "gatewayType": { "target": "com.amazonaws.rtbfabric#GatewayType", "traits": { "smithy.api#documentation": "The type of gateway. Valid values are EXTERNAL or INTERNAL.
The external inbound endpoint for the responder gateway.
" } }, "clientRoutingPolicy": { "target": "com.amazonaws.rtbfabric#ClientRoutingPolicy", "traits": { "smithy.api#documentation": "The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. RTB Fabric omits this member if the gateway has never had a client routing policy. An omitted value means that the gateway uses AVAILABILITY_ZONE_AFFINITY. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.
Returns ResourceNotFoundException for an updateId past the 90-day retention window, indistinguishable in the response from an id that never existed.
", "smithy.api#examples": [ { "title": "Get an update", "documentation": "Get one routing rule update on a responder gateway", "input": { "gatewayId": "rtb-gw-12345678", "updateId": "update-1a2b3c4d5e6f" }, "output": { "update": { "updateId": "update-1a2b3c4d5e6f", "type": "ROUTING_RULE_UPDATE", "status": "SUCCESSFUL", "target": { "routingRule": { "linkId": "link-87654321", "ruleId": "rule-abc123def456" } }, "createdAt": "2026-10-01T12:00:00Z", "parameters": { "routingRule": { "priority": 20, "conditions": { "hostHeader": "api.customer.com" } } } } } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/gateway/{gatewayId}/updates/{updateId}" }, "smithy.api#readonly": {} } }, "com.amazonaws.rtbfabric#GetUpdateRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "updateId": { "target": "com.amazonaws.rtbfabric#UpdateId", "traits": { "smithy.api#documentation": "The unique identifier of the update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#GetUpdateResponse": { "type": "structure", "members": { "update": { "target": "com.amazonaws.rtbfabric#Update", "traits": { "smithy.api#documentation": "The update.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#HeaderTagAction": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The name of the bid action.
", "smithy.api#required": {} } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The value of the bid action.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the header tag for a bid action.
" } }, "com.amazonaws.rtbfabric#HealthCheckConfig": { "type": "structure", "members": { "port": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The port to use for health check probes. Valid range is 80 to 65535.
", "smithy.api#range": { "min": 80, "max": 65535 }, "smithy.api#required": {} } }, "path": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The destination path for the health check request. Must start with /.
The protocol to use for health check probes.
" } }, "timeoutMs": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.
", "smithy.api#range": { "min": 100, "max": 5000 } } }, "intervalSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The interval between health check probes, in seconds. Valid range is 5 to 60.
", "smithy.api#range": { "min": 5, "max": 60 } } }, "statusCodeMatcher": { "target": "com.amazonaws.rtbfabric#StatusCodeMatcher", "traits": { "smithy.api#documentation": "The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example, 200), a range (for example, 200-299), or a comma-separated list (for example, 200,204).
The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.
", "smithy.api#range": { "min": 2, "max": 10 } } }, "unhealthyThresholdCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.
", "smithy.api#range": { "min": 2, "max": 10 } } } }, "traits": { "smithy.api#documentation": "The health check configuration for a managed endpoint. Defines how the service probes instances in the Auto Scaling group to determine their health status.
" } }, "com.amazonaws.rtbfabric#InboundExternalLink": { "type": "resource", "identifiers": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId" }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId" } }, "create": { "target": "com.amazonaws.rtbfabric#CreateInboundExternalLink" }, "operations": [ { "target": "com.amazonaws.rtbfabric#DeleteInboundExternalLink" }, { "target": "com.amazonaws.rtbfabric#GetInboundExternalLink" } ], "traits": { "aws.api#arn": { "template": "gateway/{gatewayId}/link/{linkId}" } } }, "com.amazonaws.rtbfabric#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request could not be completed because of an internal server error. Try your call again.
", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.rtbfabric#KubernetesClusterName": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 63 }, "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$" } }, "com.amazonaws.rtbfabric#KubernetesEndpointsResourceName": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 63 }, "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$" } }, "com.amazonaws.rtbfabric#KubernetesNamespace": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 63 }, "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]$" } }, "com.amazonaws.rtbfabric#Link": { "type": "resource", "identifiers": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId" }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId" } }, "create": { "target": "com.amazonaws.rtbfabric#CreateLink" }, "read": { "target": "com.amazonaws.rtbfabric#GetLink" }, "delete": { "target": "com.amazonaws.rtbfabric#DeleteLink" }, "list": { "target": "com.amazonaws.rtbfabric#ListLinks" }, "operations": [ { "target": "com.amazonaws.rtbfabric#AcceptLink" }, { "target": "com.amazonaws.rtbfabric#PutLinkFlows" }, { "target": "com.amazonaws.rtbfabric#RejectLink" }, { "target": "com.amazonaws.rtbfabric#UpdateLink" }, { "target": "com.amazonaws.rtbfabric#UpdateLinkModuleFlow" } ], "resources": [ { "target": "com.amazonaws.rtbfabric#LinkRoutingRule" } ], "traits": { "aws.api#arn": { "template": "gateway/{gatewayId}/link/{linkId}" } } }, "com.amazonaws.rtbfabric#LinkApplicationLogConfiguration": { "type": "structure", "members": { "sampling": { "target": "com.amazonaws.rtbfabric#LinkApplicationLogSampling", "traits": { "smithy.api#documentation": "Describes a link application log sample.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the configuration of a link application log.
" } }, "com.amazonaws.rtbfabric#LinkApplicationLogSampling": { "type": "structure", "members": { "errorLog": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "An error log entry.
", "smithy.api#range": { "min": 0.0, "max": 100.0 }, "smithy.api#required": {} } }, "filterLog": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "A filter log entry.
", "smithy.api#range": { "min": 0.0, "max": 100.0 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes a link application log sample.
" } }, "com.amazonaws.rtbfabric#LinkAttributes": { "type": "structure", "members": { "responderErrorMasking": { "target": "com.amazonaws.rtbfabric#ResponderErrorMasking", "traits": { "smithy.api#documentation": "Describes the masking for HTTP error codes.
" } }, "customerProvidedId": { "target": "com.amazonaws.rtbfabric#CustomerProvidedId", "traits": { "smithy.api#documentation": "The customer-provided unique identifier of the link.
" } } }, "traits": { "smithy.api#documentation": "Describes the attributes of a link.
" } }, "com.amazonaws.rtbfabric#LinkConfigParameters": { "type": "structure", "members": { "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings" }, "timeoutInMillis": { "target": "com.amazonaws.rtbfabric#LinkTimeoutInMillis", "traits": { "smithy.api#documentation": "The timeout value in milliseconds.
" } } }, "traits": { "smithy.api#documentation": "A requested link configuration.
" } }, "com.amazonaws.rtbfabric#LinkDirection": { "type": "enum", "members": { "RESPONSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESPONSE" } }, "REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUEST" } } } }, "com.amazonaws.rtbfabric#LinkFlowParameters": { "type": "union", "members": { "modules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The requested modules.
" } }, "flows": { "target": "com.amazonaws.rtbfabric#FlowList" } }, "traits": { "smithy.api#documentation": "A requested link flow.
" } }, "com.amazonaws.rtbfabric#LinkId": { "type": "string", "traits": { "smithy.api#length": { "min": 6, "max": 30 }, "smithy.api#pattern": "^link-[a-z0-9-]{1,25}$" } }, "com.amazonaws.rtbfabric#LinkList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#ListLinksResponseStructure" } }, "com.amazonaws.rtbfabric#LinkLogSettings": { "type": "structure", "members": { "applicationLogs": { "target": "com.amazonaws.rtbfabric#LinkApplicationLogConfiguration", "traits": { "smithy.api#documentation": "Describes the configuration of a link application log.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the settings for a link log.
" } }, "com.amazonaws.rtbfabric#LinkRoutingRule": { "type": "resource", "identifiers": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId" }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId" }, "ruleId": { "target": "com.amazonaws.rtbfabric#RuleId" } }, "create": { "target": "com.amazonaws.rtbfabric#CreateLinkRoutingRule" }, "read": { "target": "com.amazonaws.rtbfabric#GetLinkRoutingRule" }, "update": { "target": "com.amazonaws.rtbfabric#UpdateLinkRoutingRule" }, "delete": { "target": "com.amazonaws.rtbfabric#DeleteLinkRoutingRule" }, "list": { "target": "com.amazonaws.rtbfabric#ListLinkRoutingRules" }, "traits": { "aws.api#arn": { "template": "gateway/{gatewayId}/link/{linkId}/routing-rule/{ruleId}" } } }, "com.amazonaws.rtbfabric#LinkRoutingRuleList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#LinkRoutingRuleSummary" } }, "com.amazonaws.rtbfabric#LinkRoutingRuleSummary": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.rtbfabric#RuleId", "traits": { "smithy.api#documentation": "The unique identifier of the routing rule.
", "smithy.api#required": {} } }, "priority": { "target": "com.amazonaws.rtbfabric#RulePriority", "traits": { "smithy.api#documentation": "The priority of the routing rule.
", "smithy.api#required": {} } }, "conditions": { "target": "com.amazonaws.rtbfabric#RuleCondition", "traits": { "smithy.api#documentation": "The conditions for the routing rule.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#RuleStatus", "traits": { "smithy.api#documentation": "The status of the routing rule.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the routing rule was created.
", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the routing rule was last updated.
", "smithy.api#required": {} } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
" } } }, "traits": { "smithy.api#documentation": "A summary of a link routing rule.
" } }, "com.amazonaws.rtbfabric#LinkStatus": { "type": "enum", "members": { "PENDING_CREATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_CREATION" } }, "PENDING_REQUEST": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_REQUEST" } }, "REQUESTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REQUESTED" } }, "ACCEPTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCEPTED" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "PENDING_DELETION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_DELETION" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "PENDING_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_UPDATE" } }, "PENDING_ISOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_ISOLATION" } }, "ISOLATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ISOLATED" } }, "PENDING_RESTORATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_RESTORATION" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_FAILED" } }, "DELETE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_FAILED" } } } }, "com.amazonaws.rtbfabric#LinkTarget": { "type": "structure", "members": { "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The link an update targeted.
" } }, "com.amazonaws.rtbfabric#LinkTimeoutInMillis": { "type": "long", "traits": { "smithy.api#range": { "min": 100, "max": 5000 } } }, "com.amazonaws.rtbfabric#ListAvailableModuleVersions": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#ListAvailableModuleVersionsRequest" }, "output": { "target": "com.amazonaws.rtbfabric#ListAvailableModuleVersionsResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the ACTIVE and DEPRECATED versions of a module that you can attach, highest version first (numerically by MAJOR, then MINOR, then PATCH). If you can't attach the module, the operation returns ResourceNotFoundException, the same as for a missing one. If the module has no ACTIVE or DEPRECATED versions, the operation returns an empty list. The operation lists DEPRECATED versions so that you can inspect one that you've attached, but you can't attach them. Results are paginated. Use nextToken to get the next page.
The module's ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#ModuleVersionStatus", "traits": { "smithy.api#documentation": "Lists only versions in this status. Only ACTIVE and DEPRECATED versions are listed, so another value returns an empty list.
", "smithy.api#httpQuery": "status" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of results for each page, from 1 to 10. The default is 10.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 10 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours; using an expired token fails with ValidationException.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#ListAvailableModuleVersionsResponse": { "type": "structure", "members": { "moduleId": { "target": "com.amazonaws.rtbfabric#ModuleId", "traits": { "smithy.api#documentation": "The module's ID.
", "smithy.api#required": {} } }, "versions": { "target": "com.amazonaws.rtbfabric#AvailableModuleVersionSummaryList", "traits": { "smithy.api#documentation": "The versions on this page, highest version first.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours; using an expired token fails with ValidationException.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#ListAvailableModules": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#ListAvailableModulesRequest" }, "output": { "target": "com.amazonaws.rtbfabric#ListAvailableModulesResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the modules that you can attach, newest first by createdAt. Results are paginated. Use nextToken to get the next page.
Lists only modules that you have access to this way.
", "smithy.api#httpQuery": "subscriptionType" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of results for each page, from 1 to 10. The default is 10.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 10 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours; using an expired token fails with ValidationException.
", "smithy.api#httpQuery": "nextToken" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#ListAvailableModulesResponse": { "type": "structure", "members": { "modules": { "target": "com.amazonaws.rtbfabric#AvailableModuleSummaryList", "traits": { "smithy.api#documentation": "The modules on this page, newest first.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours; using an expired token fails with ValidationException.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#ListCertificateAssociations": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#ListCertificateAssociationsRequest" }, "output": { "target": "com.amazonaws.rtbfabric#ListCertificateAssociationsResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the certificate associations for a responder gateway.
", "smithy.api#examples": [ { "title": "List certificate associations for a responder gateway", "documentation": "Retrieve all certificate associations for a responder gateway", "input": { "gatewayId": "rtb-gw-12345678", "maxResults": 5 }, "output": { "certificateAssociations": [ { "acmCertificateArn": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012", "status": "ASSOCIATED", "associatedAt": 1704067200, "updatedAt": 1704067200 } ], "nextToken": "token123" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/responder-gateway/{gatewayId}/certificates" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "certificateAssociations" }, "smithy.api#readonly": {} } }, "com.amazonaws.rtbfabric#ListCertificateAssociationsRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 10 } } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.rtbfabric#ResponderGateway" } ] } }, "com.amazonaws.rtbfabric#ListCertificateAssociationsResponse": { "type": "structure", "members": { "certificateAssociations": { "target": "com.amazonaws.rtbfabric#CertificateAssociationSummaryList", "traits": { "smithy.api#documentation": "The list of certificate associations for the gateway.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Lists the routing rules for a link.
", "smithy.api#examples": [ { "title": "List link routing rules", "documentation": "List all routing rules for a link", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "maxResults": 10 }, "output": { "rules": [ { "ruleId": "rule-abc123def456", "priority": 10, "conditions": { "hostHeader": "api.customer.com" }, "status": "ACTIVE", "createdAt": "2024-01-01T12:00:00Z", "updatedAt": "2024-01-01T12:00:00Z" } ], "nextToken": "token123" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/responder-gateway/{gatewayId}/link/{linkId}/routing-rules" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "rules" }, "smithy.api#readonly": {} } }, "com.amazonaws.rtbfabric#ListLinkRoutingRulesRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 10 } } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.rtbfabric#Gateway" }, { "resource": "com.amazonaws.rtbfabric#Link" } ] } }, "com.amazonaws.rtbfabric#ListLinkRoutingRulesResponse": { "type": "structure", "members": { "rules": { "target": "com.amazonaws.rtbfabric#LinkRoutingRuleList", "traits": { "smithy.api#documentation": "The list of routing rules for the link.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Lists links associated with gateways.
Returns a list of all links for the specified gateways, including their status and configuration details.
", "smithy.api#examples": [ { "title": "List links for a gateway", "documentation": "Lists all links for the specified gateway", "input": { "gatewayId": "rtb-gw-12345678", "maxResults": 10 }, "output": { "links": [ { "linkId": "link-87654321", "gatewayId": "rtb-gw-12345678", "peerGatewayId": "rtb-gw-87654321", "status": "ACTIVE", "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:35:00Z" } ] } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/gateway/{gatewayId}/links/" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "links" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListLinks", "params": { "gatewayId": "rtb-gw-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#ListLinksRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", "smithy.api#httpQuery": "maxResults" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#ListLinksResponse": { "type": "structure", "members": { "links": { "target": "com.amazonaws.rtbfabric#LinkList", "traits": { "smithy.api#documentation": "Information about created links.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The unique identifier of the gateway.
", "smithy.api#required": {} } }, "peerGatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the peer gateway.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the link.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the link was created.
", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the link was updated.
", "smithy.api#required": {} } }, "direction": { "target": "com.amazonaws.rtbfabric#LinkDirection", "traits": { "smithy.api#documentation": "The direction of the link.
" } }, "flowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "Describes the configuration of flow modules.
" } }, "pendingFlowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "Describes the configuration of pending flow modules.
" } }, "attributes": { "target": "com.amazonaws.rtbfabric#LinkAttributes", "traits": { "smithy.api#documentation": "Describes attributes of a link.
" } }, "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings" }, "connectivityType": { "target": "com.amazonaws.rtbfabric#ConnectivityType", "traits": { "smithy.api#documentation": "The connectivity type of the link.
" } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
" } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign to the resource.
" } }, "publicEndpoint": { "target": "com.amazonaws.rtbfabric#URL", "traits": { "smithy.api#documentation": "The public endpoint of the outbound link.
" } } }, "traits": { "smithy.api#documentation": "Describes a link.
" } }, "com.amazonaws.rtbfabric#ListRequesterGateways": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#ListRequesterGatewaysRequest" }, "output": { "target": "com.amazonaws.rtbfabric#ListRequesterGatewaysResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists requester gateways.
", "smithy.api#examples": [ { "title": "List requester gateways with default pagination", "documentation": "Lists requester gateways using default pagination settings", "input": { "maxResults": 10 }, "output": { "gatewayIds": [ "rtb-gw-12345", "rtb-gw-67890" ] } }, { "title": "List requester gateways with pagination token", "documentation": "Lists requester gateways using a pagination token to get the next page", "input": { "maxResults": 5, "nextToken": "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVxLTEyMzQ1In19fQ==" }, "output": { "gatewayIds": [ "rtb-gw-12345", "rtb-gw-09876" ], "nextToken": "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVxLWZnaGlqIn19fQ==" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/requester-gateways" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "gatewayIds" }, "smithy.api#readonly": {} } }, "com.amazonaws.rtbfabric#ListRequesterGatewaysRequest": { "type": "structure", "members": { "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": 10, "smithy.api#documentation": "The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 10 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The unique identifier of the gateways.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Lists reponder gateways.
", "smithy.api#examples": [ { "title": "List responder gateways with default pagination", "documentation": "Lists responder gateways using default pagination settings", "input": { "maxResults": 10 }, "output": { "gatewayIds": [ "rtb-gw-54321", "rtb-gw-09876" ] } }, { "title": "List responder gateways with pagination token", "documentation": "Lists responder gateways using a pagination token to get the next page", "input": { "maxResults": 3, "nextToken": "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVzcC01NDMyMSJ9fX0=" }, "output": { "gatewayIds": [ "rtb-gw-12345", "rtb-gw-09876" ], "nextToken": "eyJsYXN0RXZhbHVhdGVkS2V5Ijp7ImlkIjp7IlMiOiJydGJhcHAtcmVzcC1hYmMzNCJ9fX0=" } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/responder-gateways" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "gatewayIds" }, "smithy.api#readonly": {} } }, "com.amazonaws.rtbfabric#ListResponderGatewaysRequest": { "type": "structure", "members": { "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": 10, "smithy.api#documentation": "The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.
This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 10 } } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
The unique identifier of the gateways.
" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
Lists tags for a resource.
", "smithy.api#examples": [ { "title": "List tags for a resource", "documentation": "Lists tags for a resource", "input": { "resourceArn": "arn:aws:rtbfabric:us-east-1:123456789012:gateway/rtb-gw-12345678" }, "output": { "tags": { "Environment": "Production", "Team": "RTB" } } } ], "smithy.api#http": { "code": 200, "method": "GET", "uri": "/tags/{resourceArn}" }, "smithy.api#readonly": {}, "smithy.test#smokeTests": [ { "id": "ListTagsForResource_GatewayOnly", "params": { "resourceArn": "arn:aws:rtbfabric:us-west-2:123456789012:gateway/rtb-gw-123testapp" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } }, { "id": "ListTagsForResource_GatewayWithLink", "params": { "resourceArn": "arn:aws:rtbfabric:us-west-2:123456789012:gateway/rtb-gw-123testapp/link/link-nonexistent" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.rtbfabric#RtbTaggableResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs for the tag or tags assigned to the specified resource.
" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#ListUpdates": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#ListUpdatesRequest" }, "output": { "target": "com.amazonaws.rtbfabric#ListUpdatesResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Lists the updates on a gateway. Results are paginated. Use nextToken to get the next page.
The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The ID of a link on this gateway, to list only that link's updates. Omit both linkId and ruleId to list the gateway's own updates.
The ID of a routing rule, to list only that rule's updates. Requires linkId, because you address a rule through its link. A ruleId without linkId fails with ValidationException.
Lists only updates of this type.
", "smithy.api#httpQuery": "type" } }, "status": { "target": "com.amazonaws.rtbfabric#UpdateStatus", "traits": { "smithy.api#documentation": "Lists only updates in this status.
", "smithy.api#httpQuery": "status" } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
", "smithy.api#httpQuery": "nextToken", "smithy.api#length": { "max": 2048 } } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The maximum number of results to return for each call.
", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#ListUpdatesResponse": { "type": "structure", "members": { "updates": { "target": "com.amazonaws.rtbfabric#UpdateSummaryList", "traits": { "smithy.api#documentation": "The updates on this page.
", "smithy.api#required": {} } }, "nextToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "If nextToken is returned, there are more results available. Make the call again using the returned token to retrieve the next page.
", "smithy.api#length": { "max": 2048 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#ListenerConfig": { "type": "structure", "members": { "protocols": { "target": "com.amazonaws.rtbfabric#ProtocolList", "traits": { "smithy.api#documentation": "The protocol for connections from clients to the gateway
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Listener configuration for the protocols (HTTP, HTTPS, or both) accepted by the gateway.
" } }, "com.amazonaws.rtbfabric#LockToken": { "type": "string", "traits": { "smithy.api#documentation": "A concurrency precondition that you read from GetLink. It's opaque, so pass it back unchanged. It has no time limit. It goes stale only when a change to the link is accepted, by any operation, including a call made with this token. Until then, reads return the same token, so a failed call leaves it valid. A token is valid only for the link that it was read from.
", "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.rtbfabric#ManagedEndpointConfiguration": { "type": "union", "members": { "autoScalingGroups": { "target": "com.amazonaws.rtbfabric#AutoScalingGroupsConfiguration", "traits": { "smithy.api#documentation": "Describes the configuration of an auto scaling group.
" } }, "eksEndpoints": { "target": "com.amazonaws.rtbfabric#EksEndpointsConfiguration", "traits": { "smithy.api#documentation": "Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.
" } } }, "traits": { "smithy.api#documentation": "Describes the configuration of a managed endpoint.
" } }, "com.amazonaws.rtbfabric#ModuleArn": { "type": "string", "traits": { "smithy.api#documentation": "ARN of a module: arn:aws:rtbfabric:{region}::modules/{moduleId}. The account field is empty.
", "smithy.api#length": { "max": 1011 }, "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:rtbfabric:[a-z0-9-]+::modules/module-[a-zA-Z0-9]{1,25}$" } }, "com.amazonaws.rtbfabric#ModuleConfiguration": { "type": "structure", "members": { "version": { "target": "com.amazonaws.rtbfabric#Version", "traits": { "smithy.api#documentation": "The version of the module.
" } }, "name": { "target": "com.amazonaws.rtbfabric#FlowModuleName", "traits": { "smithy.api#documentation": "The name of the module.
", "smithy.api#required": {} } }, "dependsOn": { "target": "com.amazonaws.rtbfabric#FlowModuleNameList", "traits": { "smithy.api#documentation": "The dependencies of the module.
" } }, "moduleParameters": { "target": "com.amazonaws.rtbfabric#ModuleParameters", "traits": { "smithy.api#documentation": "Describes the parameters of a module.
" } } }, "traits": { "smithy.api#documentation": "Describes the configuration of a module.
" } }, "com.amazonaws.rtbfabric#ModuleConfigurationList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#ModuleConfiguration" } }, "com.amazonaws.rtbfabric#ModuleDescription": { "type": "string", "traits": { "smithy.api#documentation": "Description of a module
", "smithy.api#length": { "max": 1024 } } }, "com.amazonaws.rtbfabric#ModuleId": { "type": "string", "traits": { "smithy.api#documentation": "The unique identifier of a module, for example module-8kq2p9wx3fnv1c5htj7bd0ral or module-openrtbAttributeFilter.
Describes the parameters of a no bid module.
" } }, "openRtbAttribute": { "target": "com.amazonaws.rtbfabric#OpenRtbAttributeModuleParameters", "traits": { "smithy.api#documentation": "Describes the parameters of an open RTB attribute module.
" } }, "rateLimiter": { "target": "com.amazonaws.rtbfabric#RateLimiterModuleParameters", "traits": { "smithy.api#documentation": "Describes the parameters of a rate limit.
" } } }, "traits": { "smithy.api#documentation": "Describes the parameters of a module.
" } }, "com.amazonaws.rtbfabric#ModulePermission": { "type": "enum", "members": { "READ_REQUEST_BODY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Read the bid request body.
", "smithy.api#enumValue": "READ_REQUEST_BODY" } }, "READ_REQUEST_HEADERS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Read the bid request headers.
", "smithy.api#enumValue": "READ_REQUEST_HEADERS" } }, "MUTATE_REQUEST_BODY": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Change the bid request body.
", "smithy.api#enumValue": "MUTATE_REQUEST_BODY" } }, "ENRICH_REQUEST_HEADERS": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Add headers to the bid request.
", "smithy.api#enumValue": "ENRICH_REQUEST_HEADERS" } }, "ENRICH_REQUEST_EXT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Write data into the bid request's ext object.
", "smithy.api#enumValue": "ENRICH_REQUEST_EXT" } }, "FILTER": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Drop the bid request and return a no-bid.
", "smithy.api#enumValue": "FILTER" } } }, "traits": { "smithy.api#documentation": "A data-access grant that a version holds.
" } }, "com.amazonaws.rtbfabric#ModulePermissionList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#ModulePermission" }, "traits": { "smithy.api#length": { "min": 1, "max": 16 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.rtbfabric#ModuleVersionArn": { "type": "string", "traits": { "smithy.api#documentation": "arn:aws:rtbfabric:{REGION}::modules/{MODULE_ID}/versions/{VERSION}. The account field is empty: a module's ARN doesn't carry its owner's account.
", "smithy.api#length": { "max": 1011 }, "smithy.api#pattern": "^arn:aws[a-zA-Z-]*:rtbfabric:[a-z0-9-]+::modules/module-[a-zA-Z0-9]{1,25}/versions/(0|[1-9]\\d{0,9})\\.(0|[1-9]\\d{0,9})\\.(0|[1-9]\\d{0,9})$" } }, "com.amazonaws.rtbfabric#ModuleVersionStatus": { "type": "enum", "members": { "CREATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Being validated.
", "smithy.api#enumValue": "CREATING" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Terminal. Re-publish as a new version.
", "smithy.api#enumValue": "CREATE_FAILED" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Attachable.
", "smithy.api#enumValue": "ACTIVE" } }, "DEPRECATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "Terminal. Can't be attached.
", "smithy.api#enumValue": "DEPRECATED" } } }, "traits": { "smithy.api#documentation": "A version is CREATING while it is validated, then ACTIVE or CREATE_FAILED. An ACTIVE version becomes DEPRECATED at the time its vendor schedules.
" } }, "com.amazonaws.rtbfabric#NoBidAction": { "type": "structure", "members": { "noBidReasonCode": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The reason code for the no bid action.
", "smithy.api#range": { "min": 0 } } } }, "traits": { "smithy.api#documentation": "Describes a no bid action.
" } }, "com.amazonaws.rtbfabric#NoBidModuleParameters": { "type": "structure", "members": { "reason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The reason description.
", "smithy.api#length": { "min": 1, "max": 50 }, "smithy.api#pattern": "^[a-zA-Z0-9]*$" } }, "reasonCode": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The reason code.
", "smithy.api#range": { "min": 0, "max": 10 } } }, "passThroughPercentage": { "target": "smithy.api#Float", "traits": { "smithy.api#documentation": "The pass through percentage.
", "smithy.api#range": { "min": 0, "max": 100 } } } }, "traits": { "smithy.api#documentation": "Describes the parameters of a no bid module.
" } }, "com.amazonaws.rtbfabric#OpenRtbAttributeModuleParameters": { "type": "structure", "members": { "filterType": { "target": "com.amazonaws.rtbfabric#FilterType", "traits": { "smithy.api#documentation": "The filter type.
", "smithy.api#required": {} } }, "filterConfiguration": { "target": "com.amazonaws.rtbfabric#FilterConfiguration", "traits": { "smithy.api#documentation": "Describes the configuration of a filter.
", "smithy.api#required": {} } }, "action": { "target": "com.amazonaws.rtbfabric#Action", "traits": { "smithy.api#documentation": "Describes a bid action.
", "smithy.api#required": {} } }, "holdbackPercentage": { "target": "smithy.api#Float", "traits": { "smithy.api#documentation": "The hold back percentage.
", "smithy.api#range": { "min": 0, "max": 100 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the parameters of an open RTB attribute module.
" } }, "com.amazonaws.rtbfabric#OutboundExternalLink": { "type": "resource", "identifiers": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId" }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId" } }, "create": { "target": "com.amazonaws.rtbfabric#CreateOutboundExternalLink" }, "operations": [ { "target": "com.amazonaws.rtbfabric#DeleteOutboundExternalLink" }, { "target": "com.amazonaws.rtbfabric#GetOutboundExternalLink" } ], "traits": { "aws.api#arn": { "template": "gateway/{gatewayId}/link/{linkId}" } } }, "com.amazonaws.rtbfabric#PhasedPipeline": { "type": "structure", "members": { "phases": { "target": "com.amazonaws.rtbfabric#FlowPhaseList", "traits": { "smithy.api#documentation": "At most 8 modules in total across the phases; more fails with ValidationException.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Phases that run in order; each starts after the previous one completes.
" } }, "com.amazonaws.rtbfabric#Protocol": { "type": "enum", "members": { "HTTP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTP" } }, "HTTPS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HTTPS" } } } }, "com.amazonaws.rtbfabric#ProtocolList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#Protocol" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.rtbfabric#PutLinkFlows": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#PutLinkFlowsRequest" }, "output": { "target": "com.amazonaws.rtbfabric#PutLinkFlowsResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Replaces a link's flow configuration. The change applies asynchronously. The call returns once the change is accepted, and the link serves its prior flows until the update commits atomically. RTB Fabric validates the request before accepting it, and a request that fails validation changes nothing. After the call, use GetLink. Once the change completes, the link's status is ACTIVE again and its flows show the change.
", "smithy.api#examples": [ { "title": "Attach a filter module in one sequential flow", "input": { "gatewayId": "rtb-gw-a1b2c3d4e5", "linkId": "link-f6g7h8i9j0", "clientToken": "3f1c2a7e-0b5d-4c1e-9a8f-2d6b7e9c0a14", "lockToken": "c2VxPTQy", "flows": [ { "name": "main", "pipeline": { "sequential": { "modules": [ { "name": "domain-filter", "moduleVersionArn": "arn:aws:rtbfabric:us-east-1::modules/module-a1b2c3d4e5f6g7h8i9j0k1l2m/versions/1.2.0", "selectedActions": [ "FILTER" ] } ] } } } ] }, "output": { "gatewayId": "rtb-gw-a1b2c3d4e5", "linkId": "link-f6g7h8i9j0", "status": "PENDING_UPDATE", "updateId": "update-1a2b3c4d5e6f" } }, { "title": "Run enrichment modules concurrently in a phased flow", "documentation": "Filters first, then runs two enrichment modules at the same time. The second phase costs the slower of the two modules rather than their sum. Both enrichment modules fail open, so a slow vendor drops its enrichment instead of losing the bid.", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "clientToken": "6b1d84f2-0a97-4e53-b8c1-3d5f7a2e9048", "lockToken": "lt-7f3a9c2e1b", "flows": [ { "name": "default", "pipeline": { "phased": { "phases": [ { "modules": [ { "name": "GeoFilter", "moduleVersionArn": "arn:aws:rtbfabric:us-east-1::modules/module-openrtbAttributeFilter/versions/2.0.0", "failureMode": "CLOSED", "configurationValues": "{\"filterType\":\"INCLUDE\",\"filterConfiguration\":[{\"criteria\":[{\"path\":\"$.device.geo.country\",\"values\":[\"USA\"]}]}]}" } ] }, { "modules": [ { "name": "IVTDetection", "moduleVersionArn": "arn:aws:rtbfabric:us-east-1::modules/module-0a1b2c3d4e5f/versions/1.0.0", "failureMode": "OPEN", "configurationValues": "{\"threshold\":0.7}" }, { "name": "Viewability", "moduleVersionArn": "arn:aws:rtbfabric:us-east-1::modules/module-9f8e7d6c5b4a/versions/1.0.0", "failureMode": "OPEN" } ] } ] } } } ] }, "output": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "status": "PENDING_UPDATE", "updateId": "update-4d5e6f7a8b9c" } }, { "title": "Detach every module from a link", "documentation": "Puts an empty set of flows. There is no separate detach operation: removal is expressed by putting the flows the caller wants to keep, and keeping none removes all of them.", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "clientToken": "9c4e2a71-5d38-4b0f-8e62-7f1a4c9d3b05", "lockToken": "lt-7f3a9c2e1b", "flows": [] }, "output": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "status": "PENDING_UPDATE", "updateId": "update-7a8b9c1d2e3f" } } ], "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/gateway/{gatewayId}/link/{linkId}/flows" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rtbfabric#PutLinkFlowsRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "clientToken": { "target": "com.amazonaws.rtbfabric#ClientToken", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry with the same token and parameters, you get the original response without an error. If you retry with the same token but different parameters, the call fails with ValidationException. If you don't provide a token, the SDK generates one, and RTB Fabric remembers it for 8 hours. A retry returns the original updateId before lockToken is checked.
The concurrency token that you read from GetLink. If the link changed since that read, by any operation, the call fails with ConflictException.
", "smithy.api#required": {} } }, "flows": { "target": "com.amazonaws.rtbfabric#FlowList", "traits": { "smithy.api#documentation": "The link's flows, replacing the current ones. An empty list removes every flow.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#PutLinkFlowsResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The link's status. A successful call returns PENDING_UPDATE, and the link serves its prior flows until the change completes.
", "smithy.api#required": {} } }, "updateId": { "target": "com.amazonaws.rtbfabric#UpdateId", "traits": { "smithy.api#documentation": "The ID of the update this call started.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#QueryStringKeyValuePair": { "type": "structure", "members": { "key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The key of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[A-Za-z0-9._~-]+$", "smithy.api#required": {} } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The value of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[A-Za-z0-9._~-]+$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A key-value pair for query string matching in a routing rule condition.
" } }, "com.amazonaws.rtbfabric#RTBFabric": { "type": "service", "version": "2023-05-15", "operations": [ { "target": "com.amazonaws.rtbfabric#GetAvailableModule" }, { "target": "com.amazonaws.rtbfabric#GetAvailableModuleVersion" }, { "target": "com.amazonaws.rtbfabric#ListAvailableModules" }, { "target": "com.amazonaws.rtbfabric#ListAvailableModuleVersions" }, { "target": "com.amazonaws.rtbfabric#ListRequesterGateways" }, { "target": "com.amazonaws.rtbfabric#ListResponderGateways" }, { "target": "com.amazonaws.rtbfabric#ListTagsForResource" }, { "target": "com.amazonaws.rtbfabric#TagResource" }, { "target": "com.amazonaws.rtbfabric#UntagResource" } ], "resources": [ { "target": "com.amazonaws.rtbfabric#Gateway" }, { "target": "com.amazonaws.rtbfabric#RequesterGateway" }, { "target": "com.amazonaws.rtbfabric#ResponderGateway" } ], "traits": { "aws.api#service": { "sdkId": "RTBFabric", "arnNamespace": "rtbfabric", "cloudTrailEventSource": "rtbfabric.amazonaws.com" }, "aws.auth#sigv4": { "name": "rtbfabric" }, "aws.endpoints#standardRegionalEndpoints": {}, "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ "*", "content-type", "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id", "x-amzn-trace-id" ], "additionalExposedHeaders": [ "x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id" ], "maxAge": 86400 }, "smithy.api#documentation": "Amazon Web Services RTB Fabric provides secure, low-latency infrastructure for connecting real-time bidding (RTB) applications. Rather than hosting applications directly, RTB Fabric acts as the connecting fabric that enables your applications to communicate efficiently over private networks instead of the public internet. You maintain complete control over your applications, data, and bidding decisions, while RTB Fabric provides the underlying infrastructure for secure, reliable connectivity.
You can use these APIs to complete RTB Fabric tasks, such as setting up audit log ingestions or viewing user access. For more information about RTB Fabric, including the required permissions to use the service, see the Amazon Web Services RTB Fabric User Guide.
", "smithy.api#title": "RTBFabric", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://rtbfabric-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://rtbfabric-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://rtbfabric.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://rtbfabric.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://rtbfabric-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://rtbfabric-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://rtbfabric.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://rtbfabric.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rtbfabric-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rtbfabric.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rtbfabric-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rtbfabric.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric-fips.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rtbfabric-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://rtbfabric.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://rtbfabric.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.rtbfabric#RateLimiterModuleParameters": { "type": "structure", "members": { "tps": { "target": "smithy.api#Float", "traits": { "smithy.api#documentation": "The transactions per second rate limit.
" } } }, "traits": { "smithy.api#documentation": "Describes the parameters of a rate limit.
" } }, "com.amazonaws.rtbfabric#RejectLink": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#RejectLinkRequest" }, "output": { "target": "com.amazonaws.rtbfabric#RejectLinkResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Rejects a link request between gateways.
When a requester gateway requests to link with a responder gateway, the responder can use this operation to decline the link request.
", "smithy.api#examples": [ { "title": "Reject a link request", "documentation": "Rejects a requested link request", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321" }, "output": { "linkId": "link-87654321", "gatewayId": "rtb-gw-12345678", "peerGatewayId": "rtb-gw-87654321", "status": "REJECTED", "createdAt": "2024-01-15T10:30:00Z", "updatedAt": "2024-01-15T10:35:00Z" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/gateway/{gatewayId}/link/{linkId}/reject" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "RejectLink", "params": { "gatewayId": "rtb-gw-12345", "linkId": "link-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#RejectLinkRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#RejectLinkResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "peerGatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the peer gateway.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the link.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the link was created.
", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the link was updated.
", "smithy.api#required": {} } }, "direction": { "target": "com.amazonaws.rtbfabric#LinkDirection", "traits": { "smithy.api#documentation": "The direction of the link.
" } }, "flowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of flow modules.
" } }, "pendingFlowModules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of pending flow modules.
" } }, "attributes": { "target": "com.amazonaws.rtbfabric#LinkAttributes", "traits": { "smithy.api#documentation": "Attributes of the link.
" } }, "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings" }, "connectivityType": { "target": "com.amazonaws.rtbfabric#ConnectivityType", "traits": { "smithy.api#documentation": "The connectivity type of the link.
" } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure, such as a deleted subnet. Present only when the resource has failed.
" } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#ReleaseNotes": { "type": "string", "traits": { "smithy.api#documentation": "The release notes for a version.
", "smithy.api#length": { "max": 4096 } } }, "com.amazonaws.rtbfabric#RequesterGateway": { "type": "resource", "identifiers": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId" } }, "create": { "target": "com.amazonaws.rtbfabric#CreateRequesterGateway" }, "read": { "target": "com.amazonaws.rtbfabric#GetRequesterGateway" }, "delete": { "target": "com.amazonaws.rtbfabric#DeleteRequesterGateway" }, "operations": [ { "target": "com.amazonaws.rtbfabric#UpdateRequesterGateway" } ], "resources": [ { "target": "com.amazonaws.rtbfabric#OutboundExternalLink" } ], "traits": { "aws.api#arn": { "template": "gateway/{gatewayId}" } } }, "com.amazonaws.rtbfabric#RequesterGatewayStatus": { "type": "enum", "members": { "PENDING_CREATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_CREATION" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "PENDING_DELETION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_DELETION" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } }, "PENDING_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_UPDATE" } }, "ISOLATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ISOLATED" } }, "PENDING_ISOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_ISOLATION" } }, "PENDING_RESTORATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_RESTORATION" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_FAILED" } }, "DELETE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_FAILED" } } } }, "com.amazonaws.rtbfabric#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request could not be completed because the resource does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.rtbfabric#ResourceUpdate": { "type": "resource", "identifiers": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId" }, "updateId": { "target": "com.amazonaws.rtbfabric#UpdateId" } }, "read": { "target": "com.amazonaws.rtbfabric#GetUpdate" }, "list": { "target": "com.amazonaws.rtbfabric#ListUpdates" } }, "com.amazonaws.rtbfabric#ResponderErrorMasking": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#ResponderErrorMaskingForHttpCode" }, "traits": { "smithy.api#length": { "min": 1, "max": 200 } } }, "com.amazonaws.rtbfabric#ResponderErrorMaskingAction": { "type": "enum", "members": { "NO_BID": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NO_BID" } }, "PASSTHROUGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PASSTHROUGH" } } } }, "com.amazonaws.rtbfabric#ResponderErrorMaskingForHttpCode": { "type": "structure", "members": { "httpCode": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The HTTP error code.
", "smithy.api#length": { "min": 3, "max": 7 }, "smithy.api#pattern": "^DEFAULT|4XX|5XX|\\d{3}$", "smithy.api#required": {} } }, "action": { "target": "com.amazonaws.rtbfabric#ResponderErrorMaskingAction", "traits": { "smithy.api#documentation": "The action for the error..
", "smithy.api#required": {} } }, "loggingTypes": { "target": "com.amazonaws.rtbfabric#ResponderErrorMaskingLoggingTypes", "traits": { "smithy.api#documentation": "The error log type.
", "smithy.api#required": {} } }, "responseLoggingPercentage": { "target": "smithy.api#Float", "traits": { "smithy.api#documentation": "The percentage of response logging.
", "smithy.api#range": { "min": 0, "max": 100 } } } }, "traits": { "smithy.api#documentation": "Describes the masking for HTTP error codes.
" } }, "com.amazonaws.rtbfabric#ResponderErrorMaskingLoggingType": { "type": "enum", "members": { "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "METRIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "METRIC" } }, "RESPONSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESPONSE" } } } }, "com.amazonaws.rtbfabric#ResponderErrorMaskingLoggingTypes": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#ResponderErrorMaskingLoggingType" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 } } }, "com.amazonaws.rtbfabric#ResponderGateway": { "type": "resource", "identifiers": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId" } }, "create": { "target": "com.amazonaws.rtbfabric#CreateResponderGateway" }, "read": { "target": "com.amazonaws.rtbfabric#GetResponderGateway" }, "delete": { "target": "com.amazonaws.rtbfabric#DeleteResponderGateway" }, "operations": [ { "target": "com.amazonaws.rtbfabric#AssociateCertificate" }, { "target": "com.amazonaws.rtbfabric#DisassociateCertificate" }, { "target": "com.amazonaws.rtbfabric#GetCertificateAssociation" }, { "target": "com.amazonaws.rtbfabric#ListCertificateAssociations" }, { "target": "com.amazonaws.rtbfabric#UpdateResponderGateway" } ], "resources": [ { "target": "com.amazonaws.rtbfabric#InboundExternalLink" } ], "traits": { "aws.api#arn": { "template": "gateway/{gatewayId}" } } }, "com.amazonaws.rtbfabric#ResponderGatewayConfigParameters": { "type": "structure", "members": { "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The gateway's description.
" } }, "clientRoutingPolicy": { "target": "com.amazonaws.rtbfabric#ClientRoutingPolicy", "traits": { "smithy.api#documentation": "The gateway's client routing policy.
" } }, "domainName": { "target": "com.amazonaws.rtbfabric#DomainName", "traits": { "smithy.api#documentation": "The gateway's domain name.
" } }, "port": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "The networking port.
", "smithy.api#required": {} } }, "protocol": { "target": "com.amazonaws.rtbfabric#Protocol", "traits": { "smithy.api#documentation": "The networking protocol.
", "smithy.api#required": {} } }, "listenerConfig": { "target": "com.amazonaws.rtbfabric#ListenerConfig" }, "trustStoreConfiguration": { "target": "com.amazonaws.rtbfabric#TrustStoreConfiguration" }, "managedEndpointConfiguration": { "target": "com.amazonaws.rtbfabric#ManagedEndpointConfiguration" } }, "traits": { "smithy.api#documentation": "A requested responder gateway configuration.
" } }, "com.amazonaws.rtbfabric#ResponderGatewayStatus": { "type": "enum", "members": { "PENDING_CREATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_CREATION" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "PENDING_DELETION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_DELETION" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } }, "PENDING_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_UPDATE" } }, "ISOLATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ISOLATED" } }, "PENDING_ISOLATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_ISOLATION" } }, "PENDING_RESTORATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING_RESTORATION" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_FAILED" } }, "DELETE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_FAILED" } } } }, "com.amazonaws.rtbfabric#RoutingRuleParameters": { "type": "structure", "members": { "priority": { "target": "com.amazonaws.rtbfabric#RulePriority", "traits": { "smithy.api#required": {} } }, "conditions": { "target": "com.amazonaws.rtbfabric#RuleCondition", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A requested routing rule.
" } }, "com.amazonaws.rtbfabric#RoutingRuleTarget": { "type": "structure", "members": { "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the rule's link.
", "smithy.api#required": {} } }, "ruleId": { "target": "com.amazonaws.rtbfabric#RuleId", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The routing rule an update targeted.
" } }, "com.amazonaws.rtbfabric#RtbTaggableResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1600 }, "smithy.api#pattern": "^arn:aws:rtbfabric:[a-zA-Z0-9_-]+:[0-9]{12}:gateway/[a-zA-Z0-9-]+(/link/[a-zA-Z0-9-]+(/routing-rule/[a-zA-Z0-9-]+)?)?$" } }, "com.amazonaws.rtbfabric#RuleCondition": { "type": "structure", "members": { "hostHeader": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "The exact host header value to match.
", "smithy.api#length": { "min": 1, "max": 255 }, "smithy.api#pattern": "^[A-Za-z0-9._~-]+$" } }, "hostHeaderWildcard": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A wildcard pattern for host header matching (for example, *.example.com).
The path prefix to match. The request path must start with this value. Must start with /.
The exact path to match. Must start with /.
A query string key-value pair that must be present and match exactly.
" } }, "queryStringExists": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A query string key that must be present in the request (any value is accepted).
", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[A-Za-z0-9._~-]+$" } } }, "traits": { "smithy.api#documentation": "The conditions for a routing rule. All specified fields must match for the rule to apply (AND logic). At least one condition field must be set.
" } }, "com.amazonaws.rtbfabric#RuleId": { "type": "string", "traits": { "smithy.api#documentation": "Identifier for a routing rule
", "smithy.api#length": { "min": 6, "max": 30 }, "smithy.api#pattern": "^rule-[a-z0-9-]{1,25}$" } }, "com.amazonaws.rtbfabric#RulePriority": { "type": "integer", "traits": { "smithy.api#documentation": "WAF-style evaluation priority. Lower number = evaluated first (priority 1 before 10). Gaps are allowed (1, 10, 20 is valid). Must be between 1 and 1000 inclusive. Uniqueness per link among non-deleted rules is enforced at the API layer (HTTP 409 on conflict).
", "smithy.api#range": { "min": 1, "max": 1000 } } }, "com.amazonaws.rtbfabric#RuleStatus": { "type": "enum", "members": { "CREATION_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATION_IN_PROGRESS" } }, "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "UPDATE_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATE_IN_PROGRESS" } }, "DELETION_IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETION_IN_PROGRESS" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "CREATE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CREATE_FAILED" } }, "DELETE_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETE_FAILED" } } }, "traits": { "smithy.api#documentation": "Status of a routing rule
" } }, "com.amazonaws.rtbfabric#SecurityGroupId": { "type": "string", "traits": { "smithy.api#length": { "min": 11, "max": 43 }, "smithy.api#pattern": "^sg-[0-9a-f]{8,40}$" } }, "com.amazonaws.rtbfabric#SecurityGroupIdList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#SecurityGroupId" } }, "com.amazonaws.rtbfabric#SelectedActionList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#ConfigurableAction" }, "traits": { "smithy.api#length": { "min": 1, "max": 16 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.rtbfabric#SemanticVersion": { "type": "string", "traits": { "smithy.api#documentation": "A three-part semantic version with no leading zeros, for example 1.0.0. Each number is at most 2,147,483,647. The vendor sets it, and a version is never reused.
In execution order.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Modules that run one after another, each on the previous module's output.
" } }, "com.amazonaws.rtbfabric#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request could not be completed because you exceeded a service quota.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.rtbfabric#StatusCodeMatcher": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.rtbfabric#SubnetId": { "type": "string", "traits": { "smithy.api#length": { "min": 15, "max": 24 }, "smithy.api#pattern": "^subnet-\\w{8,17}$" } }, "com.amazonaws.rtbfabric#SubnetIdList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#SubnetId" } }, "com.amazonaws.rtbfabric#SubscriptionStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The access is current, and you can attach the module's versions.
", "smithy.api#enumValue": "ACTIVE" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The subscription or share ended. The module is still listed, but its versions can't be attached.
", "smithy.api#enumValue": "EXPIRED" } } }, "traits": { "smithy.api#documentation": "Specifies whether your access to the module is current.
" } }, "com.amazonaws.rtbfabric#SubscriptionType": { "type": "enum", "members": { "MARKETPLACE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The access is through an AWS Marketplace subscription.
", "smithy.api#enumValue": "MARKETPLACE" } }, "PRIVATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The module is your own, or a vendor shares it with you privately.
", "smithy.api#enumValue": "PRIVATE" } }, "AWS_BUILT_IN": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The module is an AWS built-in, available to everyone.
", "smithy.api#enumValue": "AWS_BUILT_IN" } } }, "traits": { "smithy.api#documentation": "Indicates the type of access that you have to a module, such as a subscription, a private share, or a built-in.
" } }, "com.amazonaws.rtbfabric#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(resourceArn|internalId|[a-zA-Z0-9+\\-=._:/@]+)$" } }, "com.amazonaws.rtbfabric#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.rtbfabric#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#TagResourceRequest" }, "output": { "target": "com.amazonaws.rtbfabric#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Assigns one or more tags (key-value pairs) to the specified resource.
", "smithy.api#examples": [ { "title": "Add tags to a resource", "documentation": "Adds tags to a resource", "input": { "resourceArn": "arn:aws:rtbfabric:us-east-1:123456789012:gateway/rtb-gw-12345678", "tags": { "Environment": "Production", "Team": "RTB" } }, "output": {} } ], "smithy.api#http": { "code": 204, "method": "POST", "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "TagResource_GatewayOnly", "params": { "resourceArn": "arn:aws:rtbfabric:us-west-2:123456789012:gateway/rtb-gw-123testapp", "tags": { "Environment": "test", "Owner": "test-team" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } }, { "id": "TagResource_GatewayWithLink", "params": { "resourceArn": "arn:aws:rtbfabric:us-west-2:123456789012:gateway/rtb-gw-123testapp/link/link-nonexistent", "tags": { "Environment": "test", "Owner": "test-team" } }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.rtbfabric#RtbTaggableResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that you want to tag.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.rtbfabric#TagsMap", "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign to the resource.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#TagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 1600 } } }, "com.amazonaws.rtbfabric#TagsMap": { "type": "map", "key": { "target": "com.amazonaws.rtbfabric#TagKey" }, "value": { "target": "com.amazonaws.rtbfabric#TagValue" } }, "com.amazonaws.rtbfabric#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": {} } }, "com.amazonaws.rtbfabric#TrustStoreConfiguration": { "type": "structure", "members": { "certificateAuthorityCertificates": { "target": "com.amazonaws.rtbfabric#CertificateAuthorityCertificates", "traits": { "smithy.api#documentation": "The certificate authority certificate.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Describes the configuration of a trust store.
" } }, "com.amazonaws.rtbfabric#URI": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^(https|http)://(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)(?:\\.(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?))+$" } }, "com.amazonaws.rtbfabric#URL": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 255 }, "smithy.api#pattern": "^(https|http)://.+$" } }, "com.amazonaws.rtbfabric#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#UntagResourceRequest" }, "output": { "target": "com.amazonaws.rtbfabric#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Removes a tag or tags from a resource.
", "smithy.api#examples": [ { "title": "Remove tags from a resource", "documentation": "Removes tags from a resource", "input": { "resourceArn": "arn:aws:rtbfabric:us-east-1:123456789012:gateway/rtb-gw-12345678", "tagKeys": [ "Environment", "Team" ] }, "output": {} } ], "smithy.api#http": { "code": 204, "method": "DELETE", "uri": "/tags/{resourceArn}" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "UntagResource_GatewayOnly", "params": { "resourceArn": "arn:aws:rtbfabric:us-west-2:123456789012:gateway/rtb-gw-123testapp", "tagKeys": [ "Environment" ] }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } }, { "id": "UntagResource_GatewayWithLink", "params": { "resourceArn": "arn:aws:rtbfabric:us-west-2:123456789012:gateway/rtb-gw-123testapp/link/link-nonexistent", "tagKeys": [ "Environment" ] }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.rtbfabric#RtbTaggableResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource that you want to untag.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.rtbfabric#TagKeyList", "traits": { "smithy.api#documentation": "The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.
", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#UntagResourceResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#Update": { "type": "structure", "members": { "updateId": { "target": "com.amazonaws.rtbfabric#UpdateId", "traits": { "smithy.api#documentation": "The unique identifier of the update.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.rtbfabric#UpdateType", "traits": { "smithy.api#documentation": "The type of change.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#UpdateStatus", "traits": { "smithy.api#documentation": "The status of the update.
", "smithy.api#required": {} } }, "target": { "target": "com.amazonaws.rtbfabric#UpdateTarget", "traits": { "smithy.api#documentation": "The resource that the update targeted.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the update was created.
", "smithy.api#required": {} } }, "parameters": { "target": "com.amazonaws.rtbfabric#UpdateParameters", "traits": { "smithy.api#documentation": "The changes that the update requested.
" } }, "errorDetails": { "target": "com.amazonaws.rtbfabric#ErrorDetails", "traits": { "smithy.api#documentation": "The causes of the failure. Present only when the update has failed.
" } } }, "traits": { "smithy.api#documentation": "An accepted configuration change and its status.
" } }, "com.amazonaws.rtbfabric#UpdateId": { "type": "string", "traits": { "smithy.api#length": { "min": 8, "max": 64 }, "smithy.api#pattern": "^update-[a-z0-9]{1,57}$" } }, "com.amazonaws.rtbfabric#UpdateLink": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#UpdateLinkRequest" }, "output": { "target": "com.amazonaws.rtbfabric#UpdateLinkResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the configuration of a link between gateways.
Allows you to modify settings and parameters for an existing link.
", "smithy.api#examples": [ { "title": "Update link settings", "documentation": "Updates configuration settings for an existing link", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "logSettings": { "applicationLogs": { "sampling": { "errorLog": 100.0, "filterLog": 10.0 } } } }, "output": { "linkId": "link-87654321", "status": "ACTIVE", "updateId": "update-1a2b3c4d5e6f" } } ], "smithy.api#http": { "code": 200, "method": "PATCH", "uri": "/gateway/{gatewayId}/link/{linkId}" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "UpdateLink", "params": { "linkId": "link-12345", "gatewayId": "rtb-gw-12345" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#UpdateLinkModuleFlow": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#UpdateLinkModuleFlowRequest" }, "output": { "target": "com.amazonaws.rtbfabric#UpdateLinkModuleFlowResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ServiceQuotaExceededException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a link module flow.
", "smithy.api#examples": [ { "title": "Update link module flow", "documentation": "Update link module flow for link", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "clientToken": "randomClientToken", "modules": [ { "name": "noBidModule", "version": "1dot0dot0", "dependsOn": [], "moduleParameters": { "noBid": { "reason": "test", "reasonCode": 1, "passThroughPercentage": 50.0 } } } ] }, "output": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "status": "ACTIVE", "updateId": "update-3c4d5e6f7a8b" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/gateway/{gatewayId}/link/{linkId}/module-flow" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "UpdateLinkModuleFlow", "params": { "linkId": "link-12345", "gatewayId": "rtb-gw-12345", "clientToken": "xyz789uvw012", "modules": [ { "name": "module-name", "version": "version" } ] }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#UpdateLinkModuleFlowRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "modules": { "target": "com.amazonaws.rtbfabric#ModuleConfigurationList", "traits": { "smithy.api#documentation": "The configuration of a module.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#UpdateLinkModuleFlowResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } }, "updateId": { "target": "com.amazonaws.rtbfabric#UpdateId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the update this call started.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#UpdateLinkRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "logSettings": { "target": "com.amazonaws.rtbfabric#LinkLogSettings", "traits": { "smithy.api#documentation": "Settings for the application logs.
" } }, "timeoutInMillis": { "target": "com.amazonaws.rtbfabric#LinkTimeoutInMillis", "traits": { "smithy.api#documentation": "The timeout value in milliseconds.
" } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier for the request. The SDK generates one when you don't.
", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[!-~]+$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#UpdateLinkResponse": { "type": "structure", "members": { "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#LinkStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } }, "updateId": { "target": "com.amazonaws.rtbfabric#UpdateId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the update this call started.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#UpdateLinkRoutingRule": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#UpdateLinkRoutingRuleRequest" }, "output": { "target": "com.amazonaws.rtbfabric#UpdateLinkRoutingRuleResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a routing rule for a link.
", "smithy.api#examples": [ { "title": "Update a link routing rule", "documentation": "Update the conditions of a routing rule", "input": { "gatewayId": "rtb-gw-12345678", "linkId": "link-87654321", "ruleId": "rule-abc123def456", "priority": 20, "conditions": { "hostHeader": "api.customer.com", "pathPrefix": "/openrtb/" } }, "output": { "ruleId": "rule-abc123def456", "status": "UPDATE_IN_PROGRESS", "updatedAt": "2024-01-01T12:30:00Z", "updateId": "update-2b3c4d5e6f7a" } } ], "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/responder-gateway/{gatewayId}/link/{linkId}/routing-rule/{ruleId}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.rtbfabric#UpdateLinkRoutingRuleRequest": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "linkId": { "target": "com.amazonaws.rtbfabric#LinkId", "traits": { "smithy.api#documentation": "The unique identifier of the link.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ruleId": { "target": "com.amazonaws.rtbfabric#RuleId", "traits": { "smithy.api#documentation": "The unique identifier of the routing rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "priority": { "target": "com.amazonaws.rtbfabric#RulePriority", "traits": { "smithy.api#documentation": "The updated priority of the routing rule. Lower numbers are evaluated first. Valid values are 1 to 1000. Priority must be unique among non-deleted rules within a link.
", "smithy.api#required": {} } }, "conditions": { "target": "com.amazonaws.rtbfabric#RuleCondition", "traits": { "smithy.api#documentation": "The updated conditions for the routing rule. All specified fields must match for the rule to apply. At least one condition field must be set.
", "smithy.api#required": {} } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "A unique, case-sensitive identifier for the request. The SDK generates one when you don't.
", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[!-~]+$" } } }, "traits": { "smithy.api#input": {}, "smithy.api#references": [ { "resource": "com.amazonaws.rtbfabric#Gateway" }, { "resource": "com.amazonaws.rtbfabric#Link" } ] } }, "com.amazonaws.rtbfabric#UpdateLinkRoutingRuleResponse": { "type": "structure", "members": { "ruleId": { "target": "com.amazonaws.rtbfabric#RuleId", "traits": { "smithy.api#documentation": "The unique identifier of the routing rule.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#RuleStatus", "traits": { "smithy.api#documentation": "The status of the routing rule.
", "smithy.api#required": {} } }, "updatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the routing rule was last updated.
", "smithy.api#required": {} } }, "updateId": { "target": "com.amazonaws.rtbfabric#UpdateId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "The ID of the update this call started.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#UpdateParameters": { "type": "union", "members": { "responderGatewayConfig": { "target": "com.amazonaws.rtbfabric#ResponderGatewayConfigParameters", "traits": { "smithy.api#documentation": "The requested responder gateway configuration.
" } }, "linkConfig": { "target": "com.amazonaws.rtbfabric#LinkConfigParameters", "traits": { "smithy.api#documentation": "The requested link configuration.
" } }, "linkFlow": { "target": "com.amazonaws.rtbfabric#LinkFlowParameters", "traits": { "smithy.api#documentation": "The requested link flow.
" } }, "routingRule": { "target": "com.amazonaws.rtbfabric#RoutingRuleParameters", "traits": { "smithy.api#documentation": "The requested routing rule.
" } } }, "traits": { "smithy.api#documentation": "What an update requested.
" } }, "com.amazonaws.rtbfabric#UpdateRequesterGateway": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#UpdateRequesterGatewayRequest" }, "output": { "target": "com.amazonaws.rtbfabric#UpdateRequesterGatewayResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates a requester gateway.
", "smithy.api#examples": [ { "title": "Update requester gateway", "documentation": "Update requester gateway", "input": { "gatewayId": "rtb-gw-12345678", "description": "Updated requester gateway description", "clientToken": "12345678-1234-1234-1234-123456789012" }, "output": { "gatewayId": "rtb-gw-12345678", "status": "PENDING_UPDATE" } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/requester-gateway/{gatewayId}/update" }, "smithy.api#idempotent": {}, "smithy.test#smokeTests": [ { "id": "UpdateRequesterGateway", "params": { "gatewayId": "rtb-gw-12345", "description": "Updated test gateway", "clientToken": "xyz789uvw012" }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-east-1" }, "expect": { "success": {} } } ] } }, "com.amazonaws.rtbfabric#UpdateRequesterGatewayRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "An optional description for the requester gateway.
", "smithy.api#pattern": "^[A-Za-z0-9 ]+$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.rtbfabric#UpdateRequesterGatewayResponse": { "type": "structure", "members": { "gatewayId": { "target": "com.amazonaws.rtbfabric#GatewayId", "traits": { "smithy.api#documentation": "The unique identifier of the gateway.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#RequesterGatewayStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#UpdateResponderGateway": { "type": "operation", "input": { "target": "com.amazonaws.rtbfabric#UpdateResponderGatewayRequest" }, "output": { "target": "com.amazonaws.rtbfabric#UpdateResponderGatewayResponse" }, "errors": [ { "target": "com.amazonaws.rtbfabric#AccessDeniedException" }, { "target": "com.amazonaws.rtbfabric#ConflictException" }, { "target": "com.amazonaws.rtbfabric#InternalServerException" }, { "target": "com.amazonaws.rtbfabric#ResourceNotFoundException" }, { "target": "com.amazonaws.rtbfabric#ThrottlingException" }, { "target": "com.amazonaws.rtbfabric#ValidationException" } ], "traits": { "smithy.api#documentation": "Updates the description, Auto Scaling group managed endpoint configuration, trust store configuration, and client routing policy of a responder gateway. This operation also updates the protocols list in the listener configuration.
You cannot change the domainName, port, and protocol values that you set when you create a responder gateway. To change any of them, delete the gateway and create a new one.
Domain name for the responder gateway. This operation does not change the domain name of an existing gateway. To use a different domain name, delete the gateway and create a new one.
" } }, "port": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "Networking port to use. This operation does not change the port of an existing gateway. To use a different port, delete the gateway and create a new one.
", "smithy.api#range": { "min": 1, "max": 65535 }, "smithy.api#required": {} } }, "protocol": { "target": "com.amazonaws.rtbfabric#Protocol", "traits": { "smithy.api#documentation": "Networking protocol to use. This operation does not change the protocol of an existing gateway. To use a different protocol, delete the gateway and create a new one.
", "smithy.api#required": {} } }, "listenerConfig": { "target": "com.amazonaws.rtbfabric#ListenerConfig", "traits": { "smithy.api#documentation": "The listener configuration for the responder gateway.
" } }, "trustStoreConfiguration": { "target": "com.amazonaws.rtbfabric#TrustStoreConfiguration", "traits": { "smithy.api#documentation": "The configuration of the trust store.
" } }, "managedEndpointConfiguration": { "target": "com.amazonaws.rtbfabric#ManagedEndpointConfiguration", "traits": { "smithy.api#documentation": "The configuration for the managed endpoint.
" } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.
If you don't provide this value, then Amazon Web Services generates a random one for you.
If you retry the operation with the same clientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.
The unique identifier of the gateway.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "An optional description for the responder gateway.
", "smithy.api#pattern": "^[A-Za-z0-9 ]+$" } }, "clientRoutingPolicy": { "target": "com.amazonaws.rtbfabric#ClientRoutingPolicy", "traits": { "smithy.api#documentation": "The client routing policy of the gateway. This policy controls which Availability Zones RTB Fabric uses to reach the gateway for the requester gateways that send traffic to it. Valid values are the following:
AVAILABILITY_ZONE_AFFINITY: RTB Fabric routes each requester's traffic to gateway capacity in the requester's own Availability Zone when the gateway has capacity available there. Otherwise, RTB Fabric routes the traffic to gateway capacity in the other Availability Zones of the gateway.
ANY_AVAILABILITY_ZONE: RTB Fabric routes each requester's traffic to gateway capacity in every Availability Zone that the subnets of the gateway span. The Availability Zone that the requester is in does not change this.
If you don't specify a value, the gateway keeps its current client routing policy. Changing the policy sets the gateway status to PENDING_UPDATE until the change is complete. RTB Fabric does not support partial Availability Zone affinity, so PARTIAL_AVAILABILITY_ZONE_AFFINITY is not a valid value. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.
The unique identifier of the gateway.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#ResponderGatewayStatus", "traits": { "smithy.api#documentation": "The status of the request.
", "smithy.api#required": {} } }, "clientRoutingPolicy": { "target": "com.amazonaws.rtbfabric#ClientRoutingPolicy", "traits": { "smithy.api#documentation": "The client routing policy of the gateway. If the operation changed this policy, the gateway uses the new policy after its status returns to ACTIVE. For more information, see Configuring Availability Zone affinity in the Amazon Web Services RTB Fabric User Guide.
The ID of the update this call started.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.rtbfabric#UpdateStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "SUCCESSFUL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUCCESSFUL" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } } }, "com.amazonaws.rtbfabric#UpdateSummary": { "type": "structure", "members": { "updateId": { "target": "com.amazonaws.rtbfabric#UpdateId", "traits": { "smithy.api#documentation": "The unique identifier of the update.
", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.rtbfabric#UpdateType", "traits": { "smithy.api#documentation": "The type of change.
", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.rtbfabric#UpdateStatus", "traits": { "smithy.api#documentation": "The status of the update.
", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "The timestamp of when the update was created.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A summary of an update.
" } }, "com.amazonaws.rtbfabric#UpdateSummaryList": { "type": "list", "member": { "target": "com.amazonaws.rtbfabric#UpdateSummary" } }, "com.amazonaws.rtbfabric#UpdateTarget": { "type": "union", "members": { "gateway": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "The gateway itself.
" } }, "link": { "target": "com.amazonaws.rtbfabric#LinkTarget", "traits": { "smithy.api#documentation": "A link on the gateway.
" } }, "routingRule": { "target": "com.amazonaws.rtbfabric#RoutingRuleTarget", "traits": { "smithy.api#documentation": "A routing rule on one of the gateway's links.
" } } }, "traits": { "smithy.api#documentation": "What an update targeted.
" } }, "com.amazonaws.rtbfabric#UpdateType": { "type": "enum", "members": { "GATEWAY_CONFIG_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "GATEWAY_CONFIG_UPDATE" } }, "LINK_CONFIG_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LINK_CONFIG_UPDATE" } }, "LINK_FLOW_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LINK_FLOW_UPDATE" } }, "ROUTING_RULE_UPDATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ROUTING_RULE_UPDATE" } } } }, "com.amazonaws.rtbfabric#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request could not be completed because it fails satisfy the constraints specified by the service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.rtbfabric#ValueList": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.rtbfabric#Version": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 25 }, "smithy.api#pattern": "^[a-z0-9-]{1,25}$" } }, "com.amazonaws.rtbfabric#VpcId": { "type": "string", "traits": { "smithy.api#length": { "min": 12, "max": 21 }, "smithy.api#pattern": "^vpc-[a-f0-9]{8,17}$" } } } }