get_ip_set `async` ¶

get_ip_set(
    name: EntityName,
    scope: Scope,
    id: EntityId,
    *,
    config_overrides: Optional[AsyncWAFV2ClientConfig] = None,
) -> GetIPSetResponse

Retrieves the specified IPSet.

Parameters:

name (EntityName) –

The name of the IP set. You cannot change the name of an IPSet after you create it.
scope (Scope) –
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use CLOUDFRONT.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
- CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
- API and SDKs - For all calls, use the Region endpoint us-east-1.
id (EntityId) –

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Raises:

WAFInternalErrorException –

Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
WAFInvalidOperationException –

The operation isn't valid.
WAFInvalidParameterException –
The operation failed because WAF didn't recognize a parameter in the request. For example:
- You specified a parameter name or value that isn't valid.
- Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
- You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction.
- Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
WAFNonexistentItemException –

WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_wafv2/_services/async_wafv2.py

async def get_ip_set(
    self,
    name: "capo_wafv2.types.entity_name.EntityName",
    scope: "capo_wafv2.types.scope.Scope",
    id: "capo_wafv2.types.entity_id.EntityId",
    *,
    config_overrides: Optional[AsyncWAFV2ClientConfig] = None,
) -> "capo_wafv2.types.get_ip_set_response.GetIPSetResponse":
    """<p>Retrieves the specified <a>IPSet</a>.</p>

    Args:
        name: <p>The name of the IP set. You cannot change the name of an <code>IPSet</code> after you create it.</p>
        scope: <p>Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use <code>CLOUDFRONT</code>.</p> <p>To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: </p> <ul> <li> <p>CLI - Specify the Region when you use the CloudFront scope: <code>--scope=CLOUDFRONT --region=us-east-1</code>. </p> </li> <li> <p>API and SDKs - For all calls, use the Region endpoint us-east-1. </p> </li> </ul>
        id: <p>A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.</p>

    Raises:
        capo_wafv2.errors.waf_internal_error_exception.WAFInternalErrorException: <p>Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request. </p>
        capo_wafv2.errors.waf_invalid_operation_exception.WAFInvalidOperationException: <p>The operation isn't valid. </p>
        capo_wafv2.errors.waf_invalid_parameter_exception.WAFInvalidParameterException: <p>The operation failed because WAF didn't recognize a parameter in the request. For example: </p> <ul> <li> <p>You specified a parameter name or value that isn't valid.</p> </li> <li> <p>Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. </p> </li> <li> <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that isn't among the types available at <a>DefaultAction</a>.</p> </li> <li> <p>Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.</p> </li> </ul>
        capo_wafv2.errors.waf_nonexistent_item_exception.WAFNonexistentItemException: <p>WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. </p>
        capo_wafv2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_wafv2.types.get_ip_set_request.GetIPSetRequest]",
    ) -> AsyncOperationResponse[
        "capo_wafv2.types.get_ip_set_response.GetIPSetResponse"
    ]:
        import capo_wafv2._operations.awswaf_20190729.get_ip_set

        (
            output,
            http_response,
        ) = await capo_wafv2._operations.awswaf_20190729.get_ip_set.async_get_ip_set(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIPSet")
    )
    input_: capo_wafv2.types.get_ip_set_request.GetIPSetRequest = {
        "name": name,
        "scope": scope,
        "id": id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_ip_set async ¶

get_ip_set `async` ¶