list_distributions_by_web_acl_id¶
Operation¶
list_distributions_by_web_acl_id
¶
list_distributions_by_web_acl_id(request: ListDistributionsByWebACLIdInput | ListDistributionsByWebACLIdInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDistributionsByWebACLIdInputDict]) -> ListDistributionsByWebACLIdOutput
List the distributions that are associated with a specified WAF web ACL.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListDistributionsByWebACLIdInput | ListDistributionsByWebACLIdInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListDistributionsByWebACLIdInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListDistributionsByWebACLIdOutput
|
An instance of |
list_distributions_by_web_acl_id
async
¶
list_distributions_by_web_acl_id(request: ListDistributionsByWebACLIdInput | ListDistributionsByWebACLIdInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListDistributionsByWebACLIdInputDict]) -> ListDistributionsByWebACLIdOutput
List the distributions that are associated with a specified WAF web ACL.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListDistributionsByWebACLIdInput | ListDistributionsByWebACLIdInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[ListDistributionsByWebACLIdInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListDistributionsByWebACLIdOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListDistributionsByWebACLIdInputDict
¶
Bases: TypedDict
Dictionary form of ListDistributionsByWebACLIdInput.
Attributes¶
marker
instance-attribute
¶
marker: str | None
Use Marker and MaxItems to control pagination of results. If you
have more than MaxItems distributions that satisfy the request, the
response includes a NextMarker element. To get the next page of
results, submit another request. For the value of Marker, specify the
value of NextMarker from the last response. (For the first request,
omit Marker.)
max_items
instance-attribute
¶
max_items: int | None
The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
web_acl_id
instance-attribute
¶
The ID of the WAF web ACL that you want to list the associated distributions. If you specify "null" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.
For WAFV2, this is the ARN of the web ACL, such as
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
For WAF Classic, this is the ID of the web ACL, such as
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
ListDistributionsByWebACLIdInput
dataclass
¶
Bases: _SerdeShape
The request to list distributions that are associated with a specified WAF web ACL.
Attributes¶
marker
class-attribute
instance-attribute
¶
marker: str | None = ...
Use Marker and MaxItems to control pagination of results. If you
have more than MaxItems distributions that satisfy the request, the
response includes a NextMarker element. To get the next page of
results, submit another request. For the value of Marker, specify the
value of NextMarker from the last response. (For the first request,
omit Marker.)
max_items
class-attribute
instance-attribute
¶
max_items: int | None = ...
The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.
web_acl_id
class-attribute
instance-attribute
¶
web_acl_id: str | None = ...
The ID of the WAF web ACL that you want to list the associated distributions. If you specify "null" for the ID, the request returns a list of the distributions that aren't associated with a web ACL.
For WAFV2, this is the ARN of the web ACL, such as
arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
For WAF Classic, this is the ID of the web ACL, such as
a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
Output¶
ListDistributionsByWebACLIdOutput
dataclass
¶
Bases: _SerdeShape
The response to a request to list the distributions that are associated with a specified WAF web ACL.
Attributes¶
distribution_list
class-attribute
instance-attribute
¶
distribution_list: DistributionList | None = ...
The DistributionList type.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.