aws-sdk 2.1547.0 → 2.1549.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -705,11 +705,11 @@ declare namespace ELBv2 {
705
705
  */
706
706
  Name: LoadBalancerName;
707
707
  /**
708
- * The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
708
+ * The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones.
709
709
  */
710
710
  Subnets?: Subnets;
711
711
  /**
712
- * The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.
712
+ * The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets.
713
713
  */
714
714
  SubnetMappings?: SubnetMappings;
715
715
  /**
@@ -2019,7 +2019,7 @@ declare namespace ELBv2 {
2019
2019
  }
2020
2020
  export interface SourceIpConditionConfig {
2021
2021
  /**
2022
- * The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported. If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig.
2022
+ * The source IP addresses, in CIDR format. You can use both IPv4 and IPv6 addresses. Wildcards are not supported. If you specify multiple addresses, the condition is satisfied if the source IP address of the request matches one of the CIDR blocks. This condition is not satisfied by the addresses in the X-Forwarded-For header. To search for addresses in the X-Forwarded-For header, use HttpHeaderConditionConfig. The total number of values must be less than, or equal to five.
2023
2023
  */
2024
2024
  Values?: ListOfString;
2025
2025
  }
@@ -2188,7 +2188,7 @@ declare namespace ELBv2 {
2188
2188
  export type TargetGroupArns = TargetGroupArn[];
2189
2189
  export interface TargetGroupAttribute {
2190
2190
  /**
2191
- * The name of the attribute. The following attributes are supported by all load balancers: deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported. stickiness.enabled - Indicates whether target stickiness is enabled. The value is true or false. The default is false. stickiness.type - Indicates the type of stickiness. The possible values are: lb_cookie and app_cookie for Application Load Balancers. source_ip for Network Load Balancers. source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load Balancers. The following attributes are supported by Application Load Balancers and Network Load Balancers: load_balancing.cross_zone.enabled - Indicates whether cross zone load balancing is enabled. The value is true, false or use_load_balancer_configuration. The default is use_load_balancer_configuration. target_group_health.dns_failover.minimum_healthy_targets.count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are off or an integer from 1 to the maximum number of targets. The default is off. target_group_health.dns_failover.minimum_healthy_targets.percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are off or an integer from 1 to 100. The default is off. target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are 1 to the maximum number of targets. The default is 1. target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are off or an integer from 1 to 100. The default is off. The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address: load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin, least_outstanding_requests, or weighted_random. The default is round_robin. load_balancing.algorithm.anomaly_mitigation - Only available when load_balancing.algorithm.type is weighted_random. Indicates whether anomaly mitigation is enabled. The value is on or off. The default is off. slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled). stickiness.app_cookie.cookie_name - Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer. stickiness.app_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function: lambda.multi_value_headers.enabled - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client. The following attributes are supported only by Network Load Balancers: deregistration_delay.connection_termination.enabled - Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is true or false. For new UDP/TCP_UDP target groups the default is true. Otherwise, the default is false. preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value is true or false. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups. proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false. target_health_state.unhealthy.connection_termination.enabled - Indicates whether the load balancer terminates connections to unhealthy targets. The value is true or false. The default is true. The following attributes are supported only by Gateway Load Balancers: target_failover.on_deregistration - Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) can't be set independently. The value you set for both attributes must be the same. target_failover.on_unhealthy - Indicates how the Gateway Load Balancer handles existing flows when a target is unhealthy. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) cannot be set independently. The value you set for both attributes must be the same.
2191
+ * The name of the attribute. The following attributes are supported by all load balancers: deregistration_delay.timeout_seconds - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from draining to unused. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported. stickiness.enabled - Indicates whether target stickiness is enabled. The value is true or false. The default is false. stickiness.type - Indicates the type of stickiness. The possible values are: lb_cookie and app_cookie for Application Load Balancers. source_ip for Network Load Balancers. source_ip_dest_ip and source_ip_dest_ip_proto for Gateway Load Balancers. The following attributes are supported by Application Load Balancers and Network Load Balancers: load_balancing.cross_zone.enabled - Indicates whether cross zone load balancing is enabled. The value is true, false or use_load_balancer_configuration. The default is use_load_balancer_configuration. target_group_health.dns_failover.minimum_healthy_targets.count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are off or an integer from 1 to the maximum number of targets. The default is off. target_group_health.dns_failover.minimum_healthy_targets.percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, mark the zone as unhealthy in DNS, so that traffic is routed only to healthy zones. The possible values are off or an integer from 1 to 100. The default is off. target_group_health.unhealthy_state_routing.minimum_healthy_targets.count - The minimum number of targets that must be healthy. If the number of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are 1 to the maximum number of targets. The default is 1. target_group_health.unhealthy_state_routing.minimum_healthy_targets.percentage - The minimum percentage of targets that must be healthy. If the percentage of healthy targets is below this value, send traffic to all targets, including unhealthy targets. The possible values are off or an integer from 1 to 100. The default is off. The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address: load_balancing.algorithm.type - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is round_robin, least_outstanding_requests, or weighted_random. The default is round_robin. load_balancing.algorithm.anomaly_mitigation - Only available when load_balancing.algorithm.type is weighted_random. Indicates whether anomaly mitigation is enabled. The value is on or off. The default is off. slow_start.duration_seconds - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled). stickiness.app_cookie.cookie_name - Indicates the name of the application-based cookie. Names that start with the following prefixes are not allowed: AWSALB, AWSALBAPP, and AWSALBTG; they're reserved for use by the load balancer. stickiness.app_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). stickiness.lb_cookie.duration_seconds - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds). The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function: lambda.multi_value_headers.enabled - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is true or false. The default is false. If the value is false and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client. The following attributes are supported only by Network Load Balancers: deregistration_delay.connection_termination.enabled - Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is true or false. For new UDP/TCP_UDP target groups the default is true. Otherwise, the default is false. preserve_client_ip.enabled - Indicates whether client IP preservation is enabled. The value is true or false. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups. proxy_protocol_v2.enabled - Indicates whether Proxy Protocol version 2 is enabled. The value is true or false. The default is false. target_health_state.unhealthy.connection_termination.enabled - Indicates whether the load balancer terminates connections to unhealthy targets. The value is true or false. The default is true. target_health_state.unhealthy.draining_interval_seconds - The amount of time for Elastic Load Balancing to wait before changing the state of an unhealthy target from unhealthy.draining to unhealthy. The range is 0-360000 seconds. The default value is 0 seconds. Note: This attribute can only be configured when target_health_state.unhealthy.connection_termination.enabled is false. The following attributes are supported only by Gateway Load Balancers: target_failover.on_deregistration - Indicates how the Gateway Load Balancer handles existing flows when a target is deregistered. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) can't be set independently. The value you set for both attributes must be the same. target_failover.on_unhealthy - Indicates how the Gateway Load Balancer handles existing flows when a target is unhealthy. The possible values are rebalance and no_rebalance. The default is no_rebalance. The two attributes (target_failover.on_deregistration and target_failover.on_unhealthy) cannot be set independently. The value you set for both attributes must be the same.
2192
2192
  */
2193
2193
  Key?: TargetGroupAttributeKey;
2194
2194
  /**
@@ -2261,7 +2261,7 @@ declare namespace ELBv2 {
2261
2261
  }
2262
2262
  export type TargetHealthDescriptions = TargetHealthDescription[];
2263
2263
  export type TargetHealthReasonEnum = "Elb.RegistrationInProgress"|"Elb.InitialHealthChecking"|"Target.ResponseCodeMismatch"|"Target.Timeout"|"Target.FailedHealthChecks"|"Target.NotRegistered"|"Target.NotInUse"|"Target.DeregistrationInProgress"|"Target.InvalidState"|"Target.IpUnusable"|"Target.HealthCheckDisabled"|"Elb.InternalError"|string;
2264
- export type TargetHealthStateEnum = "initial"|"healthy"|"unhealthy"|"unused"|"draining"|"unavailable"|string;
2264
+ export type TargetHealthStateEnum = "initial"|"healthy"|"unhealthy"|"unhealthy.draining"|"unused"|"draining"|"unavailable"|string;
2265
2265
  export type TargetId = string;
2266
2266
  export type TargetTypeEnum = "instance"|"ip"|"lambda"|"alb"|string;
2267
2267
  export type TotalRevokedEntries = number;
package/clients/glue.d.ts CHANGED
@@ -7260,7 +7260,7 @@ declare namespace Glue {
7260
7260
  /**
7261
7261
  * The maximum size of the response.
7262
7262
  */
7263
- MaxResults?: PageSize;
7263
+ MaxResults?: OrchestrationPageSize200;
7264
7264
  }
7265
7265
  export interface GetJobRunsResponse {
7266
7266
  /**
@@ -8150,7 +8150,7 @@ declare namespace Glue {
8150
8150
  /**
8151
8151
  * The maximum size of the response.
8152
8152
  */
8153
- MaxResults?: PageSize;
8153
+ MaxResults?: OrchestrationPageSize200;
8154
8154
  }
8155
8155
  export interface GetTriggersResponse {
8156
8156
  /**
@@ -8959,7 +8959,7 @@ declare namespace Glue {
8959
8959
  */
8960
8960
  PythonVersion?: PythonVersionString;
8961
8961
  /**
8962
- * In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Working with Ray jobs in the Glue Developer Guide.
8962
+ * In Ray jobs, Runtime is used to specify the versions of Ray, Python and additional libraries available in your environment. This field is not used in other job types. For supported runtime environment values, see Supported Ray runtime environments in the Glue Developer Guide.
8963
8963
  */
8964
8964
  Runtime?: RuntimeNameString;
8965
8965
  }
@@ -9470,7 +9470,7 @@ declare namespace Glue {
9470
9470
  /**
9471
9471
  * The maximum size of a list to return.
9472
9472
  */
9473
- MaxResults?: PageSize;
9473
+ MaxResults?: OrchestrationPageSize25;
9474
9474
  /**
9475
9475
  * Filters the list by an Amazon Web Services resource tag.
9476
9476
  */
@@ -9947,7 +9947,7 @@ declare namespace Glue {
9947
9947
  /**
9948
9948
  * The maximum size of a list to return.
9949
9949
  */
9950
- MaxResults?: PageSize;
9950
+ MaxResults?: OrchestrationPageSize200;
9951
9951
  /**
9952
9952
  * Specifies to return only these tagged resources.
9953
9953
  */
@@ -9971,7 +9971,7 @@ declare namespace Glue {
9971
9971
  /**
9972
9972
  * The maximum size of a list to return.
9973
9973
  */
9974
- MaxResults?: PageSize;
9974
+ MaxResults?: OrchestrationPageSize25;
9975
9975
  }
9976
9976
  export interface ListWorkflowsResponse {
9977
9977
  /**
@@ -10450,6 +10450,8 @@ declare namespace Glue {
10450
10450
  export type OrchestrationArgumentsValue = string;
10451
10451
  export type OrchestrationIAMRoleArn = string;
10452
10452
  export type OrchestrationNameString = string;
10453
+ export type OrchestrationPageSize200 = number;
10454
+ export type OrchestrationPageSize25 = number;
10453
10455
  export type OrchestrationRoleArn = string;
10454
10456
  export type OrchestrationS3Location = string;
10455
10457
  export type OrchestrationStatementCodeString = string;
package/clients/ivs.d.ts CHANGED
@@ -43,6 +43,14 @@ declare class IVS extends Service {
43
43
  * Creates a new channel and an associated stream key to start streaming.
44
44
  */
45
45
  createChannel(callback?: (err: AWSError, data: IVS.Types.CreateChannelResponse) => void): Request<IVS.Types.CreateChannelResponse, AWSError>;
46
+ /**
47
+ * Creates a new playback restriction policy, for constraining playback by countries and/or origins.
48
+ */
49
+ createPlaybackRestrictionPolicy(params: IVS.Types.CreatePlaybackRestrictionPolicyRequest, callback?: (err: AWSError, data: IVS.Types.CreatePlaybackRestrictionPolicyResponse) => void): Request<IVS.Types.CreatePlaybackRestrictionPolicyResponse, AWSError>;
50
+ /**
51
+ * Creates a new playback restriction policy, for constraining playback by countries and/or origins.
52
+ */
53
+ createPlaybackRestrictionPolicy(callback?: (err: AWSError, data: IVS.Types.CreatePlaybackRestrictionPolicyResponse) => void): Request<IVS.Types.CreatePlaybackRestrictionPolicyResponse, AWSError>;
46
54
  /**
47
55
  * Creates a new recording configuration, used to enable recording to Amazon S3. Known issue: In the us-east-1 region, if you use the Amazon Web Services CLI to create a recording configuration, it returns success even if the S3 bucket is in a different region. In this case, the state of the recording configuration is CREATE_FAILED (instead of ACTIVE). (In other regions, the CLI correctly returns failure if the bucket is in a different region.) Workaround: Ensure that your S3 bucket is in the same region as the recording configuration. If you create a recording configuration in a different region as your S3 bucket, delete that recording configuration and create a new one with an S3 bucket from the correct region.
48
56
  */
@@ -75,6 +83,14 @@ declare class IVS extends Service {
75
83
  * Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
76
84
  */
77
85
  deletePlaybackKeyPair(callback?: (err: AWSError, data: IVS.Types.DeletePlaybackKeyPairResponse) => void): Request<IVS.Types.DeletePlaybackKeyPairResponse, AWSError>;
86
+ /**
87
+ * Deletes the specified playback restriction policy.
88
+ */
89
+ deletePlaybackRestrictionPolicy(params: IVS.Types.DeletePlaybackRestrictionPolicyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
90
+ /**
91
+ * Deletes the specified playback restriction policy.
92
+ */
93
+ deletePlaybackRestrictionPolicy(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
78
94
  /**
79
95
  * Deletes the recording configuration for the specified ARN. If you try to delete a recording configuration that is associated with a channel, you will get an error (409 ConflictException). To avoid this, for all channels that reference the recording configuration, first use UpdateChannel to set the recordingConfigurationArn field to an empty string, then use DeleteRecordingConfiguration.
80
96
  */
@@ -107,6 +123,14 @@ declare class IVS extends Service {
107
123
  * Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to private channels. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
108
124
  */
109
125
  getPlaybackKeyPair(callback?: (err: AWSError, data: IVS.Types.GetPlaybackKeyPairResponse) => void): Request<IVS.Types.GetPlaybackKeyPairResponse, AWSError>;
126
+ /**
127
+ * Gets the specified playback restriction policy.
128
+ */
129
+ getPlaybackRestrictionPolicy(params: IVS.Types.GetPlaybackRestrictionPolicyRequest, callback?: (err: AWSError, data: IVS.Types.GetPlaybackRestrictionPolicyResponse) => void): Request<IVS.Types.GetPlaybackRestrictionPolicyResponse, AWSError>;
130
+ /**
131
+ * Gets the specified playback restriction policy.
132
+ */
133
+ getPlaybackRestrictionPolicy(callback?: (err: AWSError, data: IVS.Types.GetPlaybackRestrictionPolicyResponse) => void): Request<IVS.Types.GetPlaybackRestrictionPolicyResponse, AWSError>;
110
134
  /**
111
135
  * Gets the recording configuration for the specified ARN.
112
136
  */
@@ -163,6 +187,14 @@ declare class IVS extends Service {
163
187
  * Gets summary information about playback key pairs. For more information, see Setting Up Private Channels in the Amazon IVS User Guide.
164
188
  */
165
189
  listPlaybackKeyPairs(callback?: (err: AWSError, data: IVS.Types.ListPlaybackKeyPairsResponse) => void): Request<IVS.Types.ListPlaybackKeyPairsResponse, AWSError>;
190
+ /**
191
+ * Gets summary information about playback restriction policies.
192
+ */
193
+ listPlaybackRestrictionPolicies(params: IVS.Types.ListPlaybackRestrictionPoliciesRequest, callback?: (err: AWSError, data: IVS.Types.ListPlaybackRestrictionPoliciesResponse) => void): Request<IVS.Types.ListPlaybackRestrictionPoliciesResponse, AWSError>;
194
+ /**
195
+ * Gets summary information about playback restriction policies.
196
+ */
197
+ listPlaybackRestrictionPolicies(callback?: (err: AWSError, data: IVS.Types.ListPlaybackRestrictionPoliciesResponse) => void): Request<IVS.Types.ListPlaybackRestrictionPoliciesResponse, AWSError>;
166
198
  /**
167
199
  * Gets summary information about all recording configurations in your account, in the Amazon Web Services region where the API request is processed.
168
200
  */
@@ -251,6 +283,14 @@ declare class IVS extends Service {
251
283
  * Updates a channel's configuration. Live channels cannot be updated. You must stop the ongoing stream, update the channel, and restart the stream for the changes to take effect.
252
284
  */
253
285
  updateChannel(callback?: (err: AWSError, data: IVS.Types.UpdateChannelResponse) => void): Request<IVS.Types.UpdateChannelResponse, AWSError>;
286
+ /**
287
+ * Updates a specified playback restriction policy.
288
+ */
289
+ updatePlaybackRestrictionPolicy(params: IVS.Types.UpdatePlaybackRestrictionPolicyRequest, callback?: (err: AWSError, data: IVS.Types.UpdatePlaybackRestrictionPolicyResponse) => void): Request<IVS.Types.UpdatePlaybackRestrictionPolicyResponse, AWSError>;
290
+ /**
291
+ * Updates a specified playback restriction policy.
292
+ */
293
+ updatePlaybackRestrictionPolicy(callback?: (err: AWSError, data: IVS.Types.UpdatePlaybackRestrictionPolicyResponse) => void): Request<IVS.Types.UpdatePlaybackRestrictionPolicyResponse, AWSError>;
254
294
  }
255
295
  declare namespace IVS {
256
296
  export interface AudioConfiguration {
@@ -390,6 +430,10 @@ declare namespace IVS {
390
430
  * Channel name.
391
431
  */
392
432
  name?: ChannelName;
433
+ /**
434
+ * Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
435
+ */
436
+ playbackRestrictionPolicyArn?: ChannelPlaybackRestrictionPolicyArn;
393
437
  /**
394
438
  * Channel playback URL.
395
439
  */
@@ -399,7 +443,7 @@ declare namespace IVS {
399
443
  */
400
444
  preset?: TranscodePreset;
401
445
  /**
402
- * Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
446
+ * Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
403
447
  */
404
448
  recordingConfigurationArn?: ChannelRecordingConfigurationArn;
405
449
  /**
@@ -416,6 +460,7 @@ declare namespace IVS {
416
460
  export type ChannelLatencyMode = "NORMAL"|"LOW"|string;
417
461
  export type ChannelList = ChannelSummary[];
418
462
  export type ChannelName = string;
463
+ export type ChannelPlaybackRestrictionPolicyArn = string;
419
464
  export type ChannelRecordingConfigurationArn = string;
420
465
  export interface ChannelSummary {
421
466
  /**
@@ -438,12 +483,16 @@ declare namespace IVS {
438
483
  * Channel name.
439
484
  */
440
485
  name?: ChannelName;
486
+ /**
487
+ * Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
488
+ */
489
+ playbackRestrictionPolicyArn?: ChannelPlaybackRestrictionPolicyArn;
441
490
  /**
442
491
  * Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
443
492
  */
444
493
  preset?: TranscodePreset;
445
494
  /**
446
- * Recording-configuration ARN. A value other than an empty string indicates that recording is enabled. Default: "" (empty string, recording is disabled).
495
+ * Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
447
496
  */
448
497
  recordingConfigurationArn?: ChannelRecordingConfigurationArn;
449
498
  /**
@@ -474,12 +523,16 @@ declare namespace IVS {
474
523
  * Channel name.
475
524
  */
476
525
  name?: ChannelName;
526
+ /**
527
+ * Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).
528
+ */
529
+ playbackRestrictionPolicyArn?: ChannelPlaybackRestrictionPolicyArn;
477
530
  /**
478
531
  * Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
479
532
  */
480
533
  preset?: TranscodePreset;
481
534
  /**
482
- * Recording-configuration ARN. Default: "" (empty string, recording is disabled).
535
+ * Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. Default: "" (empty string, recording is disabled).
483
536
  */
484
537
  recordingConfigurationArn?: ChannelRecordingConfigurationArn;
485
538
  /**
@@ -501,6 +554,34 @@ declare namespace IVS {
501
554
  */
502
555
  streamKey?: StreamKey;
503
556
  }
557
+ export interface CreatePlaybackRestrictionPolicyRequest {
558
+ /**
559
+ * A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
560
+ */
561
+ allowedCountries?: PlaybackRestrictionPolicyAllowedCountryList;
562
+ /**
563
+ * A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
564
+ */
565
+ allowedOrigins?: PlaybackRestrictionPolicyAllowedOriginList;
566
+ /**
567
+ * Whether channel playback is constrained by origin site. Default: false.
568
+ */
569
+ enableStrictOriginEnforcement?: PlaybackRestrictionPolicyEnableStrictOriginEnforcement;
570
+ /**
571
+ * Playback-restriction-policy name. The value does not need to be unique.
572
+ */
573
+ name?: PlaybackRestrictionPolicyName;
574
+ /**
575
+ * Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
576
+ */
577
+ tags?: Tags;
578
+ }
579
+ export interface CreatePlaybackRestrictionPolicyResponse {
580
+ /**
581
+ *
582
+ */
583
+ playbackRestrictionPolicy?: PlaybackRestrictionPolicy;
584
+ }
504
585
  export interface CreateRecordingConfigurationRequest {
505
586
  /**
506
587
  * A complex type that contains a destination configuration for where recorded video will be stored.
@@ -563,6 +644,12 @@ declare namespace IVS {
563
644
  }
564
645
  export interface DeletePlaybackKeyPairResponse {
565
646
  }
647
+ export interface DeletePlaybackRestrictionPolicyRequest {
648
+ /**
649
+ * ARN of the playback restriction policy to be deleted.
650
+ */
651
+ arn: PlaybackRestrictionPolicyArn;
652
+ }
566
653
  export interface DeleteRecordingConfigurationRequest {
567
654
  /**
568
655
  * ARN of the recording configuration to be deleted.
@@ -605,6 +692,18 @@ declare namespace IVS {
605
692
  */
606
693
  keyPair?: PlaybackKeyPair;
607
694
  }
695
+ export interface GetPlaybackRestrictionPolicyRequest {
696
+ /**
697
+ * ARN of the playback restriction policy to be returned.
698
+ */
699
+ arn: PlaybackRestrictionPolicyArn;
700
+ }
701
+ export interface GetPlaybackRestrictionPolicyResponse {
702
+ /**
703
+ *
704
+ */
705
+ playbackRestrictionPolicy?: PlaybackRestrictionPolicy;
706
+ }
608
707
  export interface GetRecordingConfigurationRequest {
609
708
  /**
610
709
  * ARN of the recording configuration to be retrieved.
@@ -696,6 +795,10 @@ declare namespace IVS {
696
795
  * Filters the channel list to match the specified name.
697
796
  */
698
797
  filterByName?: ChannelName;
798
+ /**
799
+ * Filters the channel list to match the specified policy.
800
+ */
801
+ filterByPlaybackRestrictionPolicyArn?: ChannelPlaybackRestrictionPolicyArn;
699
802
  /**
700
803
  * Filters the channel list to match the specified recording-configuration ARN.
701
804
  */
@@ -739,6 +842,26 @@ declare namespace IVS {
739
842
  */
740
843
  nextToken?: PaginationToken;
741
844
  }
845
+ export interface ListPlaybackRestrictionPoliciesRequest {
846
+ /**
847
+ * Maximum number of policies to return. Default: 1.
848
+ */
849
+ maxResults?: MaxPlaybackRestrictionPolicyResults;
850
+ /**
851
+ * The first policy to retrieve. This is used for pagination; see the nextToken response field.
852
+ */
853
+ nextToken?: PaginationToken;
854
+ }
855
+ export interface ListPlaybackRestrictionPoliciesResponse {
856
+ /**
857
+ * If there are more channels than maxResults, use nextToken in the request to get the next set.
858
+ */
859
+ nextToken?: PaginationToken;
860
+ /**
861
+ * List of the matching policies.
862
+ */
863
+ playbackRestrictionPolicies: PlaybackRestrictionPolicyList;
864
+ }
742
865
  export interface ListRecordingConfigurationsRequest {
743
866
  /**
744
867
  * Maximum number of recording configurations to return. Default: your service quota or 100, whichever is smaller.
@@ -845,6 +968,7 @@ declare namespace IVS {
845
968
  }
846
969
  export type MaxChannelResults = number;
847
970
  export type MaxPlaybackKeyPairResults = number;
971
+ export type MaxPlaybackRestrictionPolicyResults = number;
848
972
  export type MaxRecordingConfigurationResults = number;
849
973
  export type MaxStreamKeyResults = number;
850
974
  export type MaxStreamResults = number;
@@ -886,6 +1010,66 @@ declare namespace IVS {
886
1010
  tags?: Tags;
887
1011
  }
888
1012
  export type PlaybackPublicKeyMaterial = string;
1013
+ export interface PlaybackRestrictionPolicy {
1014
+ /**
1015
+ * A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
1016
+ */
1017
+ allowedCountries: PlaybackRestrictionPolicyAllowedCountryList;
1018
+ /**
1019
+ * A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
1020
+ */
1021
+ allowedOrigins: PlaybackRestrictionPolicyAllowedOriginList;
1022
+ /**
1023
+ * Playback-restriction-policy ARN
1024
+ */
1025
+ arn: PlaybackRestrictionPolicyArn;
1026
+ /**
1027
+ * Whether channel playback is constrained by origin site. Default: false.
1028
+ */
1029
+ enableStrictOriginEnforcement?: PlaybackRestrictionPolicyEnableStrictOriginEnforcement;
1030
+ /**
1031
+ * Playback-restriction-policy name. The value does not need to be unique.
1032
+ */
1033
+ name?: PlaybackRestrictionPolicyName;
1034
+ /**
1035
+ * Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
1036
+ */
1037
+ tags?: Tags;
1038
+ }
1039
+ export type PlaybackRestrictionPolicyAllowedCountry = string;
1040
+ export type PlaybackRestrictionPolicyAllowedCountryList = PlaybackRestrictionPolicyAllowedCountry[];
1041
+ export type PlaybackRestrictionPolicyAllowedOrigin = string;
1042
+ export type PlaybackRestrictionPolicyAllowedOriginList = PlaybackRestrictionPolicyAllowedOrigin[];
1043
+ export type PlaybackRestrictionPolicyArn = string;
1044
+ export type PlaybackRestrictionPolicyEnableStrictOriginEnforcement = boolean;
1045
+ export type PlaybackRestrictionPolicyList = PlaybackRestrictionPolicySummary[];
1046
+ export type PlaybackRestrictionPolicyName = string;
1047
+ export interface PlaybackRestrictionPolicySummary {
1048
+ /**
1049
+ * A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
1050
+ */
1051
+ allowedCountries: PlaybackRestrictionPolicyAllowedCountryList;
1052
+ /**
1053
+ * A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
1054
+ */
1055
+ allowedOrigins: PlaybackRestrictionPolicyAllowedOriginList;
1056
+ /**
1057
+ * Playback-restriction-policy ARN
1058
+ */
1059
+ arn: PlaybackRestrictionPolicyArn;
1060
+ /**
1061
+ * Whether channel playback is constrained by origin site. Default: false.
1062
+ */
1063
+ enableStrictOriginEnforcement?: PlaybackRestrictionPolicyEnableStrictOriginEnforcement;
1064
+ /**
1065
+ * Playback-restriction-policy name. The value does not need to be unique.
1066
+ */
1067
+ name?: PlaybackRestrictionPolicyName;
1068
+ /**
1069
+ * Tags attached to the resource. Array of 1-50 maps, each of the form string:string (key:value). See Tagging Amazon Web Services Resources for more information, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is documented there.
1070
+ */
1071
+ tags?: Tags;
1072
+ }
889
1073
  export type PlaybackURL = string;
890
1074
  export interface PutMetadataRequest {
891
1075
  /**
@@ -1248,12 +1432,16 @@ declare namespace IVS {
1248
1432
  * Channel name.
1249
1433
  */
1250
1434
  name?: ChannelName;
1435
+ /**
1436
+ * Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. If this is set to an empty string, playback restriction policy is disabled.
1437
+ */
1438
+ playbackRestrictionPolicyArn?: ChannelPlaybackRestrictionPolicyArn;
1251
1439
  /**
1252
1440
  * Optional transcode preset for the channel. This is selectable only for ADVANCED_HD and ADVANCED_SD channel types. For those channel types, the default preset is HIGHER_BANDWIDTH_DELIVERY. For other channel types (BASIC and STANDARD), preset is the empty string ("").
1253
1441
  */
1254
1442
  preset?: TranscodePreset;
1255
1443
  /**
1256
- * Recording-configuration ARN. If this is set to an empty string, recording is disabled. A value other than an empty string indicates that recording is enabled
1444
+ * Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording. If this is set to an empty string, recording is disabled.
1257
1445
  */
1258
1446
  recordingConfigurationArn?: ChannelRecordingConfigurationArn;
1259
1447
  /**
@@ -1262,8 +1450,39 @@ declare namespace IVS {
1262
1450
  type?: ChannelType;
1263
1451
  }
1264
1452
  export interface UpdateChannelResponse {
1453
+ /**
1454
+ * Object specifying the updated channel.
1455
+ */
1265
1456
  channel?: Channel;
1266
1457
  }
1458
+ export interface UpdatePlaybackRestrictionPolicyRequest {
1459
+ /**
1460
+ * A list of country codes that control geoblocking restriction. Allowed values are the officially assigned ISO 3166-1 alpha-2 codes. Default: All countries (an empty array).
1461
+ */
1462
+ allowedCountries?: PlaybackRestrictionPolicyAllowedCountryList;
1463
+ /**
1464
+ * A list of origin sites that control CORS restriction. Allowed values are the same as valid values of the Origin header defined at https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin. Default: All origins (an empty array).
1465
+ */
1466
+ allowedOrigins?: PlaybackRestrictionPolicyAllowedOriginList;
1467
+ /**
1468
+ * ARN of the playback-restriction-policy to be updated.
1469
+ */
1470
+ arn: PlaybackRestrictionPolicyArn;
1471
+ /**
1472
+ * Whether channel playback is constrained by origin site. Default: false.
1473
+ */
1474
+ enableStrictOriginEnforcement?: PlaybackRestrictionPolicyEnableStrictOriginEnforcement;
1475
+ /**
1476
+ * Playback-restriction-policy name. The value does not need to be unique.
1477
+ */
1478
+ name?: PlaybackRestrictionPolicyName;
1479
+ }
1480
+ export interface UpdatePlaybackRestrictionPolicyResponse {
1481
+ /**
1482
+ * Object specifying the updated policy.
1483
+ */
1484
+ playbackRestrictionPolicy?: PlaybackRestrictionPolicy;
1485
+ }
1267
1486
  export interface VideoConfiguration {
1268
1487
  /**
1269
1488
  * Indicates the degree of required decoder performance for a profile. Normally this is set automatically by the encoder. For details, see the H.264 specification.