Skip to content

register_instance_event_notification_attributes

register_instance_event_notification_attributes(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional[Boolean] = None,
    instance_tag_attribute: Optional[RegisterInstanceTagAttributeRequest] = None,
) -> RegisterInstanceEventNotificationAttributesResult

Registers a set of tag keys to include in scheduled event notifications for your resources.

To remove tags, use DeregisterInstanceEventNotificationAttributes.

Parameters:

  • dry_run (Optional[Boolean], default: None ) –

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • instance_tag_attribute (Optional[RegisterInstanceTagAttributeRequest], default: None ) –

    Information about the tag keys to register.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def register_instance_event_notification_attributes(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    instance_tag_attribute: Optional[
        "capo_ec2.types.register_instance_tag_attribute_request.RegisterInstanceTagAttributeRequest"
    ] = None,
) -> "capo_ec2.types.register_instance_event_notification_attributes_result.RegisterInstanceEventNotificationAttributesResult":
    """<p>Registers a set of tag keys to include in scheduled event notifications for your resources. </p> <p>To remove tags, use <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeregisterInstanceEventNotificationAttributes.html">DeregisterInstanceEventNotificationAttributes</a>.</p>

    Args:
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        instance_tag_attribute: <p>Information about the tag keys to register.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.register_instance_event_notification_attributes_request.RegisterInstanceEventNotificationAttributesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.register_instance_event_notification_attributes_result.RegisterInstanceEventNotificationAttributesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.register_instance_event_notification_attributes

        output, http_response = (
            capo_ec2._operations.amazon_ec2.register_instance_event_notification_attributes.register_instance_event_notification_attributes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("RegisterInstanceEventNotificationAttributes"),
    )
    input_: capo_ec2.types.register_instance_event_notification_attributes_request.RegisterInstanceEventNotificationAttributesRequest = {}
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if instance_tag_attribute is not None:
        input_["instance_tag_attribute"] = instance_tag_attribute

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output